youku_client 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 88241102eb4635e4dd5c689499ffe9059708ee56
-  data.tar.gz: c934e26daab56f7e827d18b15f72caf13915b429
+  metadata.gz: b2b3c6ff2e5c35ce8ec60868f4d3849e83193af1
+  data.tar.gz: 4f2d155d9876b8bad565b4d444f8f065acb7712d
 SHA512:
-  metadata.gz: 4c0ba3dc6da07a1a17b3d26ddcfa6b01b571433ac4017584ce5dca2129da268d808b873d78844a75c84de644677ea55901a1c95e26b0f58ad8e02f7219bbcde8
-  data.tar.gz: ad4a0f89d148781291e40f387f9cef780ff7e26fd7928a963dbc5aa2be6144e5ff005ea2a48af6e0d3402fb97e94b4f24a281f8191b585b78539b7b695b6151a
+  metadata.gz: 0435e878d155a98fb87352e0336b8c251cab8aacd5c5d32b36f744e9d12d1f5258fb0d25ec5cf8d53dee63bf9e2da7ee55c330aa9766aa4f454478c018456921
+  data.tar.gz: 681c598ba6d0cb3e6713391a2f4fec3cd46053bc20c9660f52d7f96dd385f690a54b8d5cd128a7de3457df65f44520660865c6eb0d0b3f389220d797220897c8

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+0.0.3
+------
+* [Completed non-authenticated portion of the comments API](https://github.com/Shuttlerock/youku_client/pull/7) ([@BenjaminSchaaf](https://github.com/BenjaminSchaaf))
+* [Completed non-authenticated portion of the users API](https://github.com/Shuttlerock/youku_client/pull/6) ([@BenjaminSchaaf](https://github.com/BenjaminSchaaf))
+* [Completed non-authenticated portion of the videos API](https://github.com/Shuttlerock/youku_client/pull/5) ([@BenjaminSchaaf](https://github.com/BenjaminSchaaf))
+
 0.0.2
 ------
 * [Fixed generated urls not matching webmocks for `nil` parameters.](https://github.com/Shuttlerock/youku_client/pull/1) ([@BenjaminSchaaf](https://github.com/BenjaminSchaaf))

data/README.md

@@ -22,11 +22,23 @@ Get users by IDs:
 
 Implemented API endpoints:
 
+  - `comments.by_video`
+  - `comments.hot.by_video`
+  - `comments.show_batch`
+  - `comments.show`
   - `searches.video.by_keyword`
+  - `users.friendship.followers`
+  - `users.friendship.followings`
   - `users.show_batch`
-  - `videos.video.by_user`
-  - `videos.video.show_batch`
-  - `videos.video.show`
+  - `users.show`
+  - `videos.by_category`
+  - `videos.by_related`
+  - `videos.by_user`
+  - `videos.favorite.by_user`
+  - `videos.show_basic_batch`
+  - `videos.show_basic`
+  - `videos.show_batch`
+  - `videos.show`
 
 ### Contributions and Pull Requests
 

data/lib/youku/v2/comments.rb

@@ -20,6 +20,63 @@ module Youku
           count:     count,
         }
       end
+
+      # Public: Get a comment by ID.
+      #
+      # See: http://open.youku.com/docs?id=32
+      #
+      # comment_id - The string comment ID.
+      #
+      # Returns the instance of Youku::V2::Request.
+      def show(comment_id: nil)
+        Youku::V2::Request.new "#{BASE_URI}/show.json", {
+          client_id:  client.client_id,
+          comment_id: comment_id,
+        }
+      end
+
+      # Public: Get comments by their IDs.
+      #
+      # See: http://open.youku.com/docs?id=34
+      #
+      # comment_ids - The string comment IDs.
+      #
+      # Returns the instance of Youku::V2::Request.
+      def show_batch(comment_ids: nil)
+        Youku::V2::Request.new "#{BASE_URI}/show_batch.json", {
+          client_id:  client.client_id,
+          comment_ids: comment_ids,
+        }
+      end
+
+      # Public: Get hot API.
+      #
+      # Returns the instance of Youku::V2::Comments::Hot.
+      def hot
+        Hot.new(client)
+      end
+
+      class Hot < Base
+        BASE_URI = "#{BASE_URI}/hot"
+
+        # Public: Get hot comments given a video.
+        #
+        # See: http://open.youku.com/docs?id=36
+        #
+        # video_id - The string video ID.
+        # page     - The Integer page number.
+        # count    - The Integer page size.
+        #
+        # Returns the instance of Youku::V2::Request.
+        def by_video(video_id: nil, page: 1, count: 20)
+          Youku::V2::Request.new "#{BASE_URI}/by_video.json", {
+            client_id: client.client_id,
+            video_id:  video_id,
+            page:      page,
+            count:     count
+          }
+        end
+      end
     end
   end
 end

data/lib/youku/v2/users.rb

@@ -34,6 +34,57 @@ module Youku
           user_name: user_name,
         }
       end
+
+      # Public: Get favourite API.
+      #
+      # Returns the instance of Youku::V2::Users::Friendship.
+      def friendship
+        Friendship.new(client)
+      end
+
+      class Friendship < Base
+        BASE_URI = "#{BASE_URI}/friendship"
+
+        # Public: Get the users following a given user.
+        #
+        # See: http://open.youku.com/docs?id=26
+        #
+        # user_id   - The String Youku user ID.
+        # user_name - The String Youku user name.
+        # page      - The Integer page number.
+        # count     - The Integer page size.
+        #
+        # Returns the instance of Youku::V2::Request.
+        def followings(user_id: nil, user_name: nil, page: 1, count: 20)
+          Youku::V2::Request.new "#{BASE_URI}/followings.json", {
+            client_id: client.client_id,
+            user_id:   user_id,
+            user_name: user_name,
+            page:      page,
+            count:     count,
+          }
+        end
+
+        # Public: Get the users a given user is following.
+        #
+        # See: http://open.youku.com/docs?id=27
+        #
+        # user_id   - The String Youku user ID.
+        # user_name - The String Youku user name.
+        # page      - The Integer page number.
+        # count     - The Integer page size.
+        #
+        # Returns the instance of Youku::V2::Request.
+        def followers(user_id: nil, user_name: nil, page: 1, count: 20)
+          Youku::V2::Request.new "#{BASE_URI}/followers.json", {
+            client_id: client.client_id,
+            user_id:   user_id,
+            user_name: user_name,
+            page:      page,
+            count:     count,
+          }
+        end
+      end
     end
   end
 end

data/lib/youku/v2/videos.rb

@@ -3,6 +3,68 @@ module Youku
     class Videos < Base
       BASE_URI = "#{BASE_URI}/videos"
 
+      # Public: Get basic information by video ID
+      #
+      # See: http://open.youku.com/docs?id=44
+      #
+      # video_id  - The video ID.
+      # video_url - The video's URL.
+      #
+      # Returns the instance of Youku::V2::Request.
+      def show_basic(video_id: nil, video_url: nil)
+        Youku::V2::Request.new "#{BASE_URI}/show_basic.json", {
+          client_id: client.client_id,
+          video_id:  video_id,
+          video_url: video_url,
+        }
+      end
+
+      # Public: Get basic information by video IDs
+      #
+      # See: http://open.youku.com/docs?id=45
+      #
+      # video_ids - The String video IDs.
+      #
+      # Returns the instance of Youku::V2::Request.
+      def show_basic_batch(video_ids: nil)
+        Youku::V2::Request.new "#{BASE_URI}/show_basic_batch.json", {
+          client_id: client.client_id,
+          video_ids: video_ids,
+        }
+      end
+
+      # Public: Get video by ID
+      #
+      # See: http://open.youku.com/docs?id=46
+      #
+      # video_id - The String video ID.
+      # ext      - The String video extension information.
+      #
+      # Returns the instance of Youku::V2::Request.
+      def show(video_id: nil, ext: nil)
+        Youku::V2::Request.new "#{BASE_URI}/show.json", {
+          client_id: client.client_id,
+          video_id:  video_id,
+          ext:       ext,
+        }
+      end
+
+      # Public: Get videos by IDs
+      #
+      # See: http://open.youku.com/docs?id=47
+      #
+      # video_ids - The comma separated String of video IDs.
+      # ext       - The String video extension information.
+      #
+      # Returns the instance of Youku::V2::Request.
+      def show_batch(video_ids: nil, ext: nil)
+        Youku::V2::Request.new "#{BASE_URI}/show_batch.json", {
+          client_id: client.client_id,
+          video_ids: video_ids,
+          ext:       ext,
+        }
+      end
+
       # Public: Get videos for given Youku user.
       #
       # See: http://open.youku.com/docs?id=49
@@ -21,42 +83,82 @@ module Youku
           user_name: user_name,
           orderby:   orderby,
           page:      page,
-          count:     count
+          count:     count,
         }
       end
 
-      # Public: Get video by ID
+      # Public: Get videos that relate to another video.
       #
-      # See: http://open.youku.com/docs?id=46
+      # See: http://open.youku.com/docs?id=52
       #
       # video_id - The String video ID.
-      # ext      - The String video extension information.
+      # count    - The Integer page size.
       #
       # Returns the instance of Youku::V2::Request.
-      def show(video_id, ext: nil)
-        Youku::V2::Request.new "#{BASE_URI}/show.json", {
+      def by_related(video_id: nil, count: 20)
+        Youku::V2::Request.new "#{BASE_URI}/by_related.json", {
           client_id: client.client_id,
           video_id:  video_id,
-          ext:       ext
+          count:     count,
         }
       end
 
-      # Public: Get videos by IDs
+      # Public: Get videos for a given category.
       #
-      # See: http://open.youku.com/docs?id=47
+      # See: http://open.youku.com/docs?id=57
       #
-      # video_ids - The comma separated String of video IDs.
-      # ext       - The String video extension information.
+      # category - The String category.
+      # genre    - The String genre.
+      # period   - The String period.
+      # orderby  - The String order of videos.
+      # page     - The Integer page number.
+      # count    - The Integer page size.
       #
       # Returns the instance of Youku::V2::Request.
-      def show_batch(video_ids: nil, ext: nil)
-        Youku::V2::Request.new "#{BASE_URI}/show_batch.json", {
+      def by_category(category: nil, genre: nil, period: nil, orderby: 'view-count', page: 1, count: 20)
+        Youku::V2::Request.new "#{BASE_URI}/by_category.json", {
           client_id: client.client_id,
-          video_ids: video_ids,
-          ext:       ext
+          category:  category,
+          genre:     genre,
+          period:    period,
+          orderby:   orderby,
+          page:      page,
+          count:     count,
         }
       end
 
+      # Public: Get favourite API.
+      #
+      # Returns the instance of Youku::V2::Videos::Favorite.
+      def favorite
+        Favorite.new(client)
+      end
+
+      class Favorite < Base
+        BASE_URI = "#{BASE_URI}/favorite"
+
+        # Public: Get a given user's favorite videos
+        #
+        # See: http://open.youku.com/docs?id=54
+        #
+        # user_id   - The String Youku user ID.
+        # user_name - The String Youku user name.
+        # orderby   - The String order of videos.
+        # page      - The Integer page number.
+        # count     - The Integer page size.
+        #
+        # Returns the instance of Youku::V2::Request.
+        def by_user(user_id: nil, user_name: nil, orderby: 'favorite-time', page: 1, count: 20)
+          Youku::V2::Request.new "#{BASE_URI}/by_user.json", {
+            client_id: client.client_id,
+            user_id:   user_id,
+            user_name: user_name,
+            orderby:   orderby,
+            page:      page,
+            count:     count,
+          }
+        end
+      end
     end
   end
 end

data/lib/youku/version.rb

@@ -1,5 +1,5 @@
 module Youku
 
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 
 end

data/spec/youku/v2/comments_spec.rb

@@ -21,4 +21,63 @@ describe Youku::V2::Comments do
 
     it_should_behave_like 'a base Youku API V2 requests'
   end
+
+  describe '#show' do
+    let(:url)   { 'https://openapi.youku.com/v2/comments/show.json' }
+    let(:query) { {
+      client_id:  client.client_id,
+      comment_id: 123,
+    } }
+
+    before do
+      stub_request(:get, url).with(query: query).to_return(status: 200)
+    end
+
+    subject { client.comments.show(comment_id: 123) }
+
+    it_should_behave_like 'a base Youku API V2 requests'
+  end
+
+  describe '#show_batch' do
+    let(:url)   { 'https://openapi.youku.com/v2/comments/show_batch.json' }
+    let(:query) { {
+      client_id:   client.client_id,
+      comment_ids: 123,
+    } }
+
+    before do
+      stub_request(:get, url).with(query: query).to_return(status: 200)
+    end
+
+    subject { client.comments.show_batch(comment_ids: 123) }
+
+    it_should_behave_like 'a base Youku API V2 requests'
+  end
+
+  describe '#hot' do
+    subject { client.comments.hot }
+
+    it { expect(subject).to be_a Youku::V2::Comments::Hot }
+    it { expect(subject.client).to eq client }
+  end
+
+  describe '::Hot' do
+    describe '#by_video' do
+      let(:url) { 'https://openapi.youku.com/v2/comments/hot/by_video.json' }
+      let(:query) { {
+        client_id: client.client_id,
+        video_id:  123,
+        page:      1,
+        count:     20
+      } }
+
+      before do
+        stub_request(:get, url).with(query: query).to_return(status: 200)
+      end
+
+      subject { client.comments.hot.by_video(video_id: 123) }
+
+      it_should_behave_like 'a base Youku API V2 requests'
+    end
+  end
 end

data/spec/youku/v2/users_spec.rb

@@ -3,7 +3,6 @@ require 'spec_helper'
 describe Youku::V2::Users do
 
   let(:client) { Youku::Client.new(client_id: 'client-id') }
-  let(:users)  { Youku::V2::Users.new(client) }
 
   describe '#show_batch' do
     let(:url)   { 'https://openapi.youku.com/v2/users/show_batch.json' }
@@ -17,7 +16,7 @@ describe Youku::V2::Users do
       stub_request(:get, url).with(query: query).to_return(status: 200)
     end
 
-    subject { users.show_batch(user_names: 'jackie_chan') }
+    subject { client.users.show_batch(user_names: 'jackie_chan') }
 
     it_should_behave_like 'a base Youku API V2 requests'
   end
@@ -34,8 +33,55 @@ describe Youku::V2::Users do
       stub_request(:get, url).with(query: query).to_return(status: 200)
     end
 
-    subject { users.show(user_name: 'jackie_chan') }
+    subject { client.users.show(user_name: 'jackie_chan') }
 
     it_should_behave_like 'a base Youku API V2 requests'
   end
+
+  describe '#friendship' do
+    subject { client.users.friendship }
+
+    it { expect(subject).to be_a Youku::V2::Users::Friendship }
+    it { expect(subject.client).to eq client }
+  end
+
+  describe '::Friendship' do
+    describe '#followings' do
+      let(:url)   { 'https://openapi.youku.com/v2/users/friendship/followings.json' }
+      let(:query) { {
+        client_id: client.client_id,
+        user_id:   '',
+        user_name: 'jackie_chan',
+        page:      1,
+        count:     20,
+      } }
+
+      before do
+        stub_request(:get, url).with(query: query).to_return(status: 200)
+      end
+
+      subject { client.users.friendship.followings(user_name: 'jackie_chan') }
+
+      it_should_behave_like 'a base Youku API V2 requests'
+    end
+
+    describe '#followers' do
+      let(:url)   { 'https://openapi.youku.com/v2/users/friendship/followers.json' }
+      let(:query) { {
+        client_id: client.client_id,
+        user_id:   '',
+        user_name: 'jackie_chan',
+        page:      1,
+        count:     20,
+      } }
+
+      before do
+        stub_request(:get, url).with(query: query).to_return(status: 200)
+      end
+
+      subject { client.users.friendship.followers(user_name: 'jackie_chan') }
+
+      it_should_behave_like 'a base Youku API V2 requests'
+    end
+  end
 end

data/spec/youku/v2/videos_spec.rb

@@ -3,21 +3,36 @@ require 'spec_helper'
 describe Youku::V2::Videos do
 
   let(:client) { Youku::Client.new(client_id: 'client-id') }
-  let(:videos) { Youku::V2::Videos.new(client) }
 
-  describe '#show_batch' do
-    let(:url)   { 'https://openapi.youku.com/v2/videos/show_batch.json' }
+  describe '#show_basic' do
+    let(:url)   { 'https://openapi.youku.com/v2/videos/show_basic.json' }
     let(:query) { {
       client_id: client.client_id,
-      video_ids: 123,
-      ext:       '',
+      video_id:  123,
+      video_url: '',
     } }
 
     before do
       stub_request(:get, url).with(query: query).to_return(status: 200)
     end
 
-    subject { videos.show_batch(video_ids: 123) }
+    subject { client.videos.show_basic(video_id: 123) }
+
+    it_should_behave_like 'a base Youku API V2 requests'
+  end
+
+  describe '#show_basic_batch' do
+    let(:url)   { 'https://openapi.youku.com/v2/videos/show_basic_batch.json' }
+    let(:query) { {
+      client_id: client.client_id,
+      video_ids:  123,
+    } }
+
+    before do
+      stub_request(:get, url).with(query: query).to_return(status: 200)
+    end
+
+    subject { client.videos.show_basic_batch(video_ids: 123) }
 
     it_should_behave_like 'a base Youku API V2 requests'
   end
@@ -34,7 +49,24 @@ describe Youku::V2::Videos do
       stub_request(:get, url).with(query: query).to_return(status: 200)
     end
 
-    subject { videos.show(123) }
+    subject { client.videos.show(video_id: 123) }
+
+    it_should_behave_like 'a base Youku API V2 requests'
+  end
+
+  describe '#show_batch' do
+    let(:url)   { 'https://openapi.youku.com/v2/videos/show_batch.json' }
+    let(:query) { {
+      client_id: client.client_id,
+      video_ids: 123,
+      ext:       '',
+    } }
+
+    before do
+      stub_request(:get, url).with(query: query).to_return(status: 200)
+    end
+
+    subject { client.videos.show_batch(video_ids: 123) }
 
     it_should_behave_like 'a base Youku API V2 requests'
   end
@@ -47,6 +79,44 @@ describe Youku::V2::Videos do
       user_name: '',
       orderby:   'published',
       page:      1,
+      count:     20,
+    } }
+
+    before do
+      stub_request(:get, url).with(query: query).to_return(status: 200)
+    end
+
+    subject { client.videos.by_user(user_id: 123) }
+
+    it_should_behave_like 'a base Youku API V2 requests'
+  end
+
+  describe '#by_related' do
+    let(:url)   { 'https://openapi.youku.com/v2/videos/by_related.json' }
+    let(:query) { {
+      client_id: client.client_id,
+      video_id:  123,
+      count:     20,
+    } }
+
+    before do
+      stub_request(:get, url).with(query: query).to_return(status: 200)
+    end
+
+    subject { client.videos.by_related(video_id: 123) }
+
+    it_should_behave_like 'a base Youku API V2 requests'
+  end
+
+  describe '#by_category' do
+    let(:url)   { 'https://openapi.youku.com/v2/videos/by_category.json' }
+    let(:query) { {
+      client_id: client.client_id,
+      category:  123,
+      genre:     456,
+      period:    789,
+      orderby:   'view-count',
+      page:      1,
       count:     20
     } }
 
@@ -54,9 +124,37 @@ describe Youku::V2::Videos do
       stub_request(:get, url).with(query: query).to_return(status: 200)
     end
 
-    subject { videos.by_user(user_id: 123) }
+    subject { client.videos.by_category(category: 123, genre: 456, period: 789) }
 
     it_should_behave_like 'a base Youku API V2 requests'
   end
 
+  describe '#favorite' do
+    subject { client.videos.favorite }
+
+    it { expect(subject).to be_a Youku::V2::Videos::Favorite }
+    it { expect(subject.client).to eq client }
+  end
+
+  describe '::Favorite' do
+    describe '#by_user' do
+      let(:url) { 'https://openapi.youku.com/v2/videos/favorite/by_user.json' }
+      let(:query) { {
+        client_id: client.client_id,
+        user_id:   123,
+        user_name: '',
+        orderby:   'favorite-time',
+        page:      1,
+        count:     20
+      } }
+
+      before do
+        stub_request(:get, url).with(query: query).to_return(status: 200)
+      end
+
+      subject { client.videos.favorite.by_user(user_id: 123) }
+
+      it_should_behave_like 'a base Youku API V2 requests'
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: youku_client
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Alexey Vokhmin
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-30 00:00:00.000000000 Z
+date: 2015-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus