Giters

jcheng31 / viki-api-gem

Viki API gem is an official wrapper gem for the Viki V4 API

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Viki API gem

This gem gives tools to access the Viki.com API.

Installation

Add the gem in your Gemfile and run bundle

gem "viki-api", require: 'viki'

Now you need to configure it. In a Rails project you can create a viki_api.rb file in your initializers folder with the following content:

Viki.configure do |c|
  # Required fields
  c.salt = 'your_salt'
  c.app_id = 'your_app_id'
  c.user_ip = -> { 'the IP of your user' }
  c.user_token = -> { 'the token of your user' }

  # Optional
  c.cache = YOUR_REDIS_INSTANCE
  c.cache_ns = 'namespace_for_your_redis_cache_keys'
  c.cache_seconds = 5 # seconds to cache
  c.logger = Logger.new(STDOUT) # The logger to use from the gem
  c.timeout_seconds = 30 # The timeout for the requests.
  c.max_concurrency = 200 # The number of concurrent connection the Gem can request with
  c.pipelining = true # Allow pipeling in Hydra
  c.memoize = true # Allow same calls to be called only once per batch
end

Configuration

  • c.salt Must contain your salt. Default to ENV["VIKI_API_SALT"]. Either in config or using ENV, it is required.

  • c.app_id Must contain your application id. Default to ENV["VIKI_API_APP_ID"]. Either in config or using ENV, it is required.

  • c.user_ip Lambda block returning the IP address of the user. It is put in the header of the requests to the API as X-FORWARDED-FOR. Required

  • c.user_token Lambda block returning the session token of the user. Required

  • c.logger Instance of Logger you want the gem to use. Default to Logger.new(STDOUT). Optional

  • c.timeout_seconds Amount of timeout seconds for the requests. If a request takes longer, it will return an error

  • c.timeout_seconds_post Amount of timeout seconds specifically for POST and PUT request. If a request takes longer, it will return an error

  • c.cache = Redis instance where the gem will store cached responses from the API. Default to nil. Optional

  • c.cache_ns Namespace for the cache keys stored in Redis. Default to viki-api-gem-cache. Optional

  • c.cache_seconds Seconds to cache responses from the API. Default to 5. Optional

Usage by examples

NOTE: Remember to run Viki.run after fetching.

Movies, Episodes

Fetch a list of episodes

Viki::Episode.fetch do |response|
  puts response.value.inspect
end

Fetch a single episode

Viki::Episode.fetch(id: "44699v") do |response|
  puts response.value.inspect
end

Fetch trending movies (videos)

Viki::Movie.trending do |response|
  puts response.value.inspect
end

Fetch recommended videos for an episode

Viki::Video.recommendations("44699v") do |response|
  puts response.value.inspect
end

Fetch popular TV shows

Viki::Series.popular do |response|
  puts response.value.inspect
end

Fetch upcoming TV shows

Viki::Series.upcoming do |response|
  puts response.value.inspect
end

Fetch container summary

Viki::ContainerSummary.fetch(id: '50c') do |response|
  puts response.value.inspect
end

Subtitles

Fetch Subtitles

Viki::Subtitle.fetch(video_id: "44699v", language: "en") do |response|
  puts response.inspect  # SRT format
end
Viki::Subtitle.fetch(video_id: "44699v", language: "en", format: 'json') do |response|
  puts response.inspect  # JSON format
end

Fetch Subtitle_completion

Viki::SubtitleCompletion.fetch(video_ids: "44699v,44700v") do |response|
  puts response.inspect
end

Fetch Subtitle_history

Viki::SubtitleHistory.fetch(user_id: "1u") do |response|
  puts response.inspect
end

Fetch recent contributions

Viki::RecentContribution.fetch(user_id: "1u") do |response|
  puts response.inspect
end

Import Subtitles

Viki::Srt.import(video_id: "44699v", language: "en", content: 'subrip text') do |response|
  puts response.inspect  # SRT format
end

Block languages

Viki::BlockedLanguages.fetch(container_id: '5269c') do |response|
  puts response.inspect
end
Viki::BlockedLanguages.create({ container_id: '5269c'}, { 'languages' => 'tr,vi' }) do |response|
  puts response.inspect
end

Video

Fetch streams for a video

Viki::Stream.fetch(video_id: '44699v') do |response|
  puts response.inspect
end

Fetch hardsub streams for a video

Viki::HardsubStream.fetch(video_id: '44699v') do |response|
  puts response.inspect
end

Viki::HardsubStream.fetch(video_id: '44699v', language: 'en') do |response|
  puts response.inspect
end

Creates a master video

Viki::MasterVideo.create(video_id: '44699v', url: "YOUTUBE_URL") do |response|
  puts response.inspect
end

Fetch Master Video

Viki::MasterVideo.fetch(video_id: '44699v') do |response|
  puts response.inspect
end

Fetch Encoding Presets

Viki::EncodingPreset.fetch do |response|
  puts response.inspect
end

Encode Video

Viki::EncodeJob.create(video_id: '44699v', profile: 'All') do |response|
  puts response.inspect
end

Replace Streams

Viki::ReplaceStream.update(old_video_id: '44699v', new_video_id: '45566v') do |response|
  puts response.inspect
end

Fetch container people

Viki::ContainerPeople.fetch(id: '50c') do |response|
  puts response.value.inspect
end

Viki::ContainerPeople.update(id: '50c', {[]}) { |r| puts r.inspect }

Viki::ContainerPeople.fetch(id: '50c', language: 'en') do |response| # Fetch the people (cast/directors) involved in a given show, with information localised in the given language
  puts response.value.inspect
end

Fetch multiple ids from container

Viki::Container.fetch(ids:'50c,504c') do |response|
  puts response.value.inspect
end

Fetch container base on type:

Film container

Viki::Film.fetch(id:'3466c') do |response|
  puts response.value.inspect
end

Series container

Viki::Series.fetch(id: '50c') do |response|
  puts response.value.inspect
end

News container

Viki::News.fetch(id: '3451c') do |response|
  puts response.value.inspect
end

Artists container

Viki::Artist.fetch(id: '4044c') do |response|
  puts response.value.inspect
end

Artist - Fetching casts information

Viki::Artist.casts_for('4044c') do |response|
  puts response.value.inspect
end

Fetch recommended containers for a container

Viki::Container.recommendations('3466c') do |response|
  puts response.value.inspect
end

Others

Fetch related news of a particular ID and resource type
Viki::RelatedNews.fetch(resource_type: 'celebrities', resource_id: '15203pr', src: 'soompi', language: 'en') do |response|
  puts response.value.inspect
end
Fetch news from a particular source
Viki::RelatedNews.fetch({src: "soompi", language: 'en', news_type:'spotlight'}) do |response|
  puts response.value.inspect
end
Viki::RelatedNews.fetch(resource_type: 'celebrities', resource_id: '15203pr', src: 'soompi', language: 'en') do |response|
  puts response.value.inspect
end
Fetch a container cover page
Viki::Cover.fetch(container_id: '50c', language: 'en') do |response|
  puts response.value.inspect
end

Subscribe a user to a container

Viki::Subscription.create({user_id: user_id}, {'resource_id' => container_id}) do |response|
  puts response.inspect
end

List subscribers of a container

Viki::Subscriber.fetch(resource_id: resource_id) do |response|
  puts response.inspect
end

Get language information

english = Viki::Language.find('en')
all_language_codes = Viki::Language.codes

Get country information

italy = Viki::Country.find('it')
all_country_codes = Viki::Country.codes

Get meta country information

italy = Viki::MetaCountry.find('rd')
all_country_codes = Viki::Country.codes

#### Create a user

```ruby
user_attributes = {first_name: "Tester",
                   last_name: "Lee",
                   email: "tester@example.com",
                   language: 'en',
                   password: "123456",
                   password_confirmation: "123456"}
Viki::User.create({}, user_attributes) do |response|
  puts response.inspect
end

Update a user

The token and the id should belong to the same user

user_new_attributes = {first_name: "new first name"}
Viki::User.update({id: user_id}, user_new_attributes) do |response|
  puts response.inspect
end

Fetch user

Viki::User.fetch(id: user_id) do |response|
  puts response.inspect
end
Viki::User.fetch(full_id: user_id) do |response|
  puts response.inspect
end

Fetch user summary

Viki::UserSummary.fetch(id: user_id) do |response|
  puts response.inspect
end

Fetch user roles

Viki::Role.fetch(user_id: user_id) do |response|
  puts response.inspect
end

Fetch container roles (staff)

Viki::Role.fetch(container_id: container_id) do |response|
  puts response.inspect
end

Fetch user about page

Viki::UserAbout.fetch(user_id: user_id) do |response|
  puts response.inspect
end

Login

Viki::Session.authenticate('tester@example.com', 'password', {}) do |response|
  puts response.inspect
end

Viki::Session.authenticate('username', 'password', {}) do |response|
  puts response.inspect
end

Logout

Viki::Session.destroy(token: user_token) do |response|
  puts response.inspect
end

Validate a token

Viki::Session.fetch(token: user_token) do |response|
  puts response.inspect
end

The gem will throw Viki::Core::ErrorResponse in case of invalid token, instead of return error object as in other methods

Send reset password

Viki::ResetPasswordToken.forgot_password!(user_email) do |response|
  puts response.inspect
end

Update password from reset password token

Viki::ResetPasswordToken.reset_password!(reset_password_token, password, password_confirmation) do |response|
  puts response.inspect
end

Fetch user activities

Viki::Activity.fetch(user_id: user_id) do | response |
  puts response.inspect
end

Fetch activities

Viki::Activity.fetch(type: 'all') do | response |
  puts response.inspect
end

See http://dev.viki.com/v4/activities/ for type params details

Private message

Viki::Thread.fetch(user_id: user_id, type: 'inbox') { |r| puts r.inspect }                 # Inbox
Viki::Thread.fetch(user_id: user_id, type: 'inbox', unread: true) { |r| puts r.inspect }   # Unread only
Viki::Thread.fetch(user_id: user_id, type: 'sent') { |r| puts r.inspect }                  # Sent
Viki::Thread.fetch(user_id: user_id, id: thread_id) { |r| puts r.inspect }                 # List messages
Viki::Thread.create({user_id: user_id}, to: to_id, content: 'hi') { |r| puts r.inspect }   # Create a thread
Viki::Thread.destroy(user_id: user_id, id: thread_id) { |r| puts r.inspect }               # Delete a thread
Viki::Thread.update(user_id: user_id, id: thread_id, unread: 'true') { |r| puts r.inspect }# Mark thread as Unread
Viki::Thread.update(user_id: user_id, id: thread_id, unread: 'false') { |r| puts r.inspect } # Mark thread as Read
Viki::Message.create({user_id: user_id, thread_id: thread_id}, content: 'hi') { |r| puts r.inspect } # Reply to a thread
Viki::Thread.unread_count(user_id) { |r| puts r.inspect }                                  # Unread count
Viki::Thread.bulk_create(user_id: user_id, usernames: 'user1,user2', content: 'hi') { |r| puts r.inspect } # Create threads with usernames

Notification

Viki::Notification.create({container_id: container_id}, content: 'hi') { |r| puts r.inspect }  # Create an announcement
Viki::Notification.fetch(user_id: user_id) { |r| puts r.inspect }                         # Inbox
Viki::Notification.fetch(user_id: user_id, unread: true) { |r| puts r.inspect }           # Unread
Viki::Notification.fetch(user_id: user_id, id: notification_id) { |r| puts r.inspect }    # Get notification
Viki::Notification.update(user_id: user_id, id: notification_id, unread: true) { |r| puts r.inspect }  # Mark as Unread
Viki::Notification.update(user_id: user_id, id: notification_id, unread: false) { |r| puts r.inspect } # Mark as Read
Viki::Notification.destroy(user_id: user_id, id: notification_id) { |r| puts r.inspect }  # Delete a notification
Viki::Notification.unread_count(user_id) { |r| puts r.inspect }                           # Unread count

Notification + Private message count

Viki::Alert.unread_count(user_id) { |r| puts r.inspect }

Contribution

Viki::Contribution.fetch(container_id: container_id) { |r| puts r.inspect }   # container specific contributions
Viki::Contribution.fetch(user_id: user_id) { |r| puts r.inspect }             # user specific contributions
Viki::Contribution.mark_as_candidate(user_id: user_id) { |r| puts r.inspect } # apply to be a contributor
Viki::Contribution.count(user_id: user_id) { |r| puts r.inspect }             # user's contribution count

Title

Viki::Title.create({container_id: container_id}, {language_code: 'en', title: 'something'}) do |r|    # Create a container title
  puts r.inspect
end

Viki::Title.create({video_id: video_id}, {language_code: 'en', title: 'something'}) do |r|    # Create a video title
  puts r.inspect
end

Description

Viki::Description.create({container_id: container_id}, {language_code: 'en', description: 'something'}) |r|   # Create a container description
  puts r.inspect
end

Viki::Description.create({video_id: video_id}, {language_code: 'en', description: 'something'}) |r|   # Create a container description
  puts r.inspect
end

Video Creation/Update

Viki::video.create({container_id: container_id}, {type: 'episode', url: 'something'}) |r|   # Create a video
  puts r.inspect
end

Viki::video.update({container_id: container_id, video_id: video_id}, {type: 'episode', url: 'something', part: 2}) |r|   # Update a video
  puts r.inspect
end

Timed Comments

Viki::TimedComment.fetch(video_id: "44699v", language: "en") do |response|
  puts response.inspect  # SRT format
end
Viki::TimedComment.destroy(video_id: "44699v", timed_comment_id: "42tc") do |response|
  puts response.inspect  # JSON format
end

Ads

Viki::Ad.fetch(video_id: '44699v') do |response|
  puts response.inspect
end

Translations

Viki::Translation.fetch(origin_language: 'en', target_language: 'es') do |response| # get translations
  puts r.inspect
end

Viki::Translation.rating(origin_subtitle_id: '1s', target_subtitle_id: '2s', like: true) do |response| # like a translation
  puts r.inspect
end

Viki::Translation.rating(origin_subtitle_id: '1s', target_subtitle_id: '2s', like: false, suggested_content: 'something') do |response| # dislike a translation with suggestion
  puts r.inspect
end

Viki::Translation.report(subtitle_id: '1s') do |response| # report a subtitle
  puts r.inspect
end

Viki::Translation.languages do |response| # get translation languages
  puts r.inspect
end

Captions

Viki::Caption.random(origin_language: 'en', target_language: 'es') do |response| # get random caption
  puts r.inspect
end

Viki::Caption.create(origin_subtitle_id: '1s', language: 'ko', content: 'new caption') do |response| # create a caption
  puts r.inspect
end

Viki::Caption.languages do |response| # get caption languages
  puts r.inspect
end

#### Video Parts

```ruby
Viki::VideoPart.fetch({video_id: video_id}) |r|   # Create a video
  puts r.inspect
end

Viki::VideoPart.create({video_id: video_id}, {end_times: '600000,1200000'}) |r|   # Create a video parts
  puts r.inspect
end

Badges

Viki::Badge.fetch |r|   # Fetch all badges
  puts r.inspect
end

Viki::Badge.fetch({user_id: '1u'}) |r|   # Fetch user's badges
  puts r.inspect
end

Tracks

Viki::Track.fetch |r|   # Fetch all tracks
  puts r.inspect
end

Wanted Lists

Viki::WantedList.fetch(name: 'list_name') |r|   # Fetch a list by name
  puts r.inspect
end

#### Recommendation lists for contributors

```ruby
Viki::Contribution.recommendation_lists |r| # Fetch recommendation lists
  puts r.inspect
end

Devices for users

Viki::Device.link('42u', {'type'=>'roku', 'device_registration_code' => 'dummy_code'})  |r| # Fetch recommendation lists
  puts r.inspect
end

Viki::Device.unlink('42u', {device_token: '42abc'})  |r| # Fetch recommendation lists
  puts r.inspect
end

Viki::Device.fetch(user_id:  '42u')|r| # Fetch recommendation lists
  puts r.inspect
end

Following

Viki::Follow.followings('42u') |r| # Fetch followings of a user (who user is following)
  puts r.inspect
end

Viki::Follow.followers('42u') |r| # Fetch followers of a user (who is following the user)
  puts r.inspect
end

####Country by Resource

Viki::CountryByResource.fetch(resource: "series") |r| # Fetch countries which have shows originating form for the resource series
  puts r.inspect
end

Person

Viki::Person.languages(person_id: "42pr") |r| # Fetch the languages that have translation for the given person_id
  puts r.inspect
end

Viki::Person.fetch(person_id: "42pr", language: "en") |r| # Fetch the person information with data localised in the given language
  puts r.inspect
end

Viki::Person.honors(person_id: "42pr") |r| # Fetch the honors/awards that the given person_id have
  puts r.inspect
end

Viki::Person.relations(person_id: "42pr", language: "en") |r| # Fetch other people related to the given person_id in the provided language
  puts r.inspect
end

Viki::Person.works(person_id: "42pr", language: "en") |r| # Fetch the works of the given person_id in the provided language
  puts r.inspect
end

PersonRole

Viki::PersonRole.fetch() |r| # Fetch the Role meta information that links a person to a work
  puts r.inspect
end

RelationType

Viki::RelationType.fetch() |r| # Fetch the Relation meta information that relates a person to another person
  puts r.inspect
end

List

Fetch List

Viki::List.fetch(id: '1l') do |res|
  puts res.inspect
end

Update List titles & descriptoin

Viki::List.update_sync({id: '1l'}, {titles: {en: "title"}, description: {en: "desc"}})

Delete List

Viki::List.destroy_sync({id: '1l'})

Update List Items

Viki::ListItem.update({list_id: '1l'}, {videos: ['1v', '2v']}) do |r|   # Update list items
  puts r.inspect
end

List Alias

Viki::ListAlias.create(list_id: '1l', name: 'alias_for_1l') |r|   # create an alias for the list
  puts r.inspect
end

### Bricks

#### Fetch brick

```ruby
Viki::Brick.fetch(id: '1b') do |res|
  puts res.inspect
end

Update brick

Viki::List.update_sync({id: '1b'} {type: "container", resource_id: '1c'})

Delete a brick

Viki::List.destroy_sync({id: '1b'})

=======

  • Contributor's count
Viki::Contributor.fetch_count(user_id: '1u') do |r|
  puts r.inspect
end
  • Contributor's meta info
Viki::Contributor.fetch_meta(user_id: '1u') do |r|
  puts r.inspect
end

Viki::Contributor.update_meta(user_id: '1u', languages: 'ja,en') do |r|
  puts r.inspect
end
  • Container years
Viki::Year.fetch do |r|
  puts r.inspect
end
  • Reported users
Viki::ReportedUser.fetch do |r|
  puts r.inspect
end

Testing Tool

Async Stub

Stub value will not be returned immediately when method get called, instead it will be recored and will be returned later when Viki.run get called.

Setup

Add this line to spec_helper.rb

require 'viki_stub'
Use

Use async_stub in replace of stub. Example:

Viki::User.async_stub(....).with(....).and_yield(...)
Limitation

Only works with built-in RSpec mock framwork

Changelog

  • 2.2.13
    • Support for /related_news endpoint
  • 2.2.12
    • Support for /reported_user endpoint
  • 2.2.11
    • Support for POST /image endpoint
  • 2.2.10
    • Support for POST /people endpoint
  • 2.2.9
    • entertainment agencies endpoint to return true source of data
  • 2.2.8
    • Support for entertainment agencies endpoint
  • 2.2.7
    • Support for resource tags endpoint
  • 2.2.6
    • Support for tags endpoint
  • 2.2.4
    • Support for trailers endpoint
  • 2.2.3
    • Support for container years endpoint
  • 2.2.2
    • Support for contributors api resource
  • 2.2.1
    • Support for PUT,PATCH,POST /bricks endpoint
    • Support for PUT,PATCH /lists endpoint
  • 2.2.0
    • Support for PATCH request
  • 2.1.1
    • Support for Person Endpoint
    • Support for RelationType Endpoint
    • Support for PersonRole Endpoint
    • Addition endpoint for ContainerPeople
  • 2.1.0
    • Gem logging configuration change. Highly coupled with Viki/Logstash requirement
  • 2.0.5
    • Allow Gem to configure max_concurrency for multi threaded application
    • Gem memoize is configuration
    • Gem can configure pipelining
  • 2.0.4
    • Country by resource endpoints
  • 2.0.3
    • Follow endpoints
  • 2.0.2
    • Update viki_utils gem
  • 2.0.1
    • Update typhoeus gem.
  • 2.0.0
    • Vikipass related refactor, breaks previous version plans, plans subscriber and gift card endpoints
  • 1.9.10
    • Recent contribution support
  • 1.9.9
    • Include file for 1.9.8 to fix bad publish
  • 1.9.8
    • Device linking endpoints
  • 1.9.7
    • Expose details attribute as optional extra attributes hash for list responses meta data
  • 1.9.6
    • MetaCountry.rb. Support endpoint to get unresolved countries with countries2.json
  • 1.9.5
    • Fix thread endpoint to send message and username in the request body
  • 1.9.4
    • Fix subtitle import endpoint to send srt content and language in the request body
  • 1.9.2
    • Add subtitle import endpoint
  • 1.9.1
    • Add bulk creating threads end point
  • 1.9.0
    • Move videos and containers endpoints back to v4
    • Specs for user.rb and user_summary.rb
  • 1.8.10
    • Add ContainerPeople container/:id/people PUT and GET
  • 1.8.9
    • Add send_email endpoint for gift_card
  • 1.8.8
    • Add Contribution Recommendation list endpoint
    • Add Wanted list endpoint
    • Add List Alias endpoint
  • 1.8.7
    • Add google_auth session support
  • 1.8.6
    • Add List Items Endpoint
  • 1.8.5
    • Add Badge Endpoint
  • 1.8.4
    • Add support for rakuten login via client side
  • 1.8.3
    • Add support to allow deleting of titles and description
  • 1.8.2
    • Cache to honor cache-control header instead of the default 5 seconds cacheable
  • 1.8.1
    • Return error for malform json from api response
  • 1.8.0
    • support for session PUT v5

About

Viki API gem is an official wrapper gem for the Viki V4 API

Languages

Language:Ruby 100.0%Language:Shell 0.0%