viki 0.0.5 → 1.0.0

data/README.md

@@ -7,23 +7,30 @@ Installation
 ----------
 Manually `gem install viki` or add `gem 'viki'` to Gemfile
 
-How to use
-----------
-Add to your .rb
+Usage
+-----
+Add where necessary
 
 	require 'viki'
 
 Initialization
 
-	viki = Viki.new('your_client_id', 'your_client_secret')
+	client = Viki.new('your_client_id', 'your_client_secret')
+
+Client is a `Viki::Client` object. When you make a method call, for example `client.movies`, the client will return a `Viki::Request` object - which you will be using to make requests. You may chain methods on the request object. The actual call to the API will only be made when you call `.get` on the request object.
 
+	viki    = client.movies	#returns a Viki::Request object
+	results = viki.get		#hits the API and returns a Viki::APIObject
 
-Responses will be returned in a `Viki::APIObject`.
+APIObject Methods
+-----------------
 
-For results that are paginated. You can use the `APIObject`'s `next` and `prev` methods to retrieve the next and previous 25 records respectively.
+Responses will be returned in a `Viki::APIObject`. See below
+
+For results that are paginated, you may use the `APIObject`'s `next` and `prev` methods to retrieve the next and previous 25 records respectively.
 
 ```
-	viki.movies
+	viki   = client.movies      #returns a Viki::Request
 	movies = viki.get			#return records in a Viki::APIObject
 
 	movies.content				#content of the API call in JSON format
@@ -37,8 +44,9 @@ For results that are paginated. You can use the `APIObject`'s `next` and `prev`
 Examples
 ----------
 * Results will always be returned in JSON format.
+* This gem simply converts Ruby methods to API endpoints. Each URL namespace is a method. This means that if there is a `/series/` url namespace, the gem's request object will have an equivalent `.series` method. See examples below for an illustration of this behaviour.
+* Refer to the [API V3 documentation](http://dev.viki.com/api "Viki API V3 Docs") for complete documentation for all Viki API endpoints.
 * All URL endpoints in the following examples should include an `access_token` parameter.
-* Refer to the [API V3 documentation](http://dev.viki.com/api "Viki API V3 Docs") for all endpoints.
 
 ### List Movies
 URL
@@ -51,8 +59,8 @@ URL
 
 Your ruby application
 
-	viki.movies.get				#without parameter filters
-	viki.movies(genre: 2).get 	#with parameter filters
+	client.movies.get				#without parameter filters
+	client.movies(genre: 2).get 	#with parameter filters
 
 ### Show Movie
 URL
@@ -61,7 +69,7 @@ URL
 
 Your ruby application
 
-	viki.movies(71459).get
+	client.movies(71459).get
 
 ### Subtitles
 URL
@@ -70,7 +78,7 @@ URL
 
 Your ruby application
 
-	viki.movies(71459).subtitles('en').get
+	client.movies(71459).subtitles('en').get
 
 ### Show Episode
 URL
@@ -79,7 +87,7 @@ URL
 
 Your ruby application
 
-	viki.series(6004).episodes(61168).get
+	client.series(6004).episodes(61168).get
 
 ### List Newscasts
 
@@ -93,11 +101,11 @@ URL
 
 Your ruby application
 
-	viki.newscasts.get					#without parameter filter
-	viki.newscasts(language: 'ko').get	#with parameter filter
+	client.newscasts.get					#without parameter filter
+	client.newscasts(language: 'ko').get	#with parameter filter
 
 RSpec Testing
-----------
+-------------
 To run the tests, create a spec_config.rb file from the sample file.
 
-Add your client id and client secret into the file.
+Add your client id and client secret into this file.

data/lib/viki/client.rb

@@ -1,14 +1,12 @@
 require 'httparty'
 require 'viki/api_object'
+require 'viki/transport'
 require 'viki/request'
 require 'multi_json'
 
 module Viki
   class Client
-    Dir[File.expand_path('../client/*.rb', __FILE__)].each { |f| require f }
-    URL_NAMESPACES = [:movies, :series, :episodes, :music_videos, :newscasts, :newsclips,
-            :artists, :featured, :coming_soon, :subtitles, :hardsubs, :genres, :countries,
-            :search, :languages]
+    include Viki::Transport
 
     def initialize(client_id, client_secret)
       @client_id = client_id
@@ -18,36 +16,12 @@ module Viki
 
     attr_reader :access_token
 
-    include Viki::Request
-
-    def get
-      current_chain = @call_chain
-      @call_chain = []
-      request(current_chain)
-    end
-
-    def reset_access_token
-      @access_token = auth_request(@client_id, @client_secret)
-    end
-
     private
     def method_missing(name, *args)
-      @call_chain ||= []
-      raise NoMethodError if not URL_NAMESPACES.include? name
-
-      curr_call = { name: name }
-
-      first_arg, second_arg = args[0], args[1]
-
-      if args.length == 1
-        first_arg.is_a?(Hash) ? curr_call.merge!({ params: first_arg }) : curr_call.merge!({ resource: first_arg })
-      elsif args.length == 2
-        curr_call.merge!({ resource: first_arg })
-        curr_call.merge!({ params: second_arg })
-      end
-
-      @call_chain.push(curr_call)
-      self
+       raise NoMethodError if not URL_NAMESPACES.include? name
+       Viki::Request.new({client_id: @client_id,
+                          client_secret: @client_secret,
+                          access_token: @access_token}, name, *args)
     end
 
   end

data/lib/viki/request.rb

@@ -1,57 +1,51 @@
-require 'uri'
-require 'httparty'
-require 'multi_json'
-require 'viki/utilities'
-
 module Viki
-  module Request
-    include Viki::Utilities
+  class Request
+    def initialize(auth_data, name, *args)
+      @access_token = auth_data[:access_token]
+      @client_id = auth_data[:client_id]
+      @client_secret = auth_data[:client_secret]
 
-    private
-    HOST = "http://www.viki.com/api/v3/"
-
-    def auth_request(client_id, client_secret)
-      params = {
-        :grant_type => 'client_credentials',
-        :client_id => client_id,
-        :client_secret => client_secret
-      }
-      response = HTTParty.post('http://viki.com/oauth/token', query: params)
-      json = MultiJson.load(response.body)
-      raise Viki::Error.new(response.header.code, json["error_description"]) if response.header.code != "200"
-      json["access_token"]
+      build_call_chain(name, *args)
     end
 
-    def request(call_chain)
-      path, params = build_url(call_chain)
-      request_url = HOST + path.chop + ".json"
+    attr_reader :access_token
 
-      response = HTTParty.get(request_url, :query => params)
+    include Viki::Transport
 
-      if response.header.code == "401"
-        self.reset_access_token
-        params.merge!({ access_token: self.access_token })
-        response = HTTParty.get(request_url, :query => params)
-      end
-
-      capture response
+    def get
+      current_chain = @call_chain
+      @call_chain = []
+      request(current_chain)
+    end
 
-      APIObject.new(response.body, self.access_token)
+    def reset_access_token
+      @access_token = auth_request(@client_id, @client_secret)
     end
 
     private
+    def method_missing(name, *args)
+      build_call_chain(name, *args)
+      self
+    end
+
+    def build_call_chain(name, *args)
+      @call_chain ||= []
+      raise NoMethodError if not URL_NAMESPACES.include? name
+
+      curr_call = { name: name }
 
-    def build_url(call_chain)
-      path = ""
-      params = { access_token: self.access_token }
+      first_arg, second_arg = args[0], args[1]
 
-      call_chain.each do |c|
-        path += "#{c[:name]}/"
-        path += "#{c[:resource]}/" if c.has_key?(:resource)
-        params.merge!(c[:params]) if c.has_key?(:params)
+      if args.length == 1
+        first_arg.is_a?(Hash) ? curr_call.merge!({ params: first_arg }) : curr_call.merge!({ resource: first_arg })
+      elsif args.length == 2
+        curr_call.merge!({ resource: first_arg })
+        curr_call.merge!({ params: second_arg })
       end
 
-      return path, params
+      @call_chain.push(curr_call)
     end
+
   end
 end
+

data/lib/viki/transport.rb

@@ -0,0 +1,55 @@
+require 'uri'
+require 'httparty'
+require 'multi_json'
+require 'viki/utilities'
+
+module Viki
+  module Transport
+    include Viki::Utilities
+
+    private
+    HOST = "http://www.viki.com/api/v3/"
+
+    def auth_request(client_id, client_secret)
+      params = {
+        :grant_type => 'client_credentials',
+        :client_id => client_id,
+        :client_secret => client_secret
+      }
+      response = HTTParty.post('http://viki.com/oauth/token', query: params)
+      json = MultiJson.load(response.body)
+      raise Viki::Error.new(response.header.code, json["error_description"]) if response.header.code != "200"
+      json["access_token"]
+    end
+
+    def request(call_chain)
+      path, params = build_url(call_chain)
+      request_url = HOST + path.chop + ".json"
+
+      response = HTTParty.get(request_url, :query => params)
+
+      if response.header.code == "401"
+        self.reset_access_token
+        params.merge!({ access_token: self.access_token })
+        response = HTTParty.get(request_url, :query => params)
+      end
+
+      capture response
+
+      APIObject.new(response.body, self.access_token)
+    end
+
+    def build_url(call_chain)
+      path = ""
+      params = { access_token: self.access_token }
+
+      call_chain.each do |c|
+        path += "#{c[:name]}/"
+        path += "#{c[:resource]}/" if c.has_key?(:resource)
+        params.merge!(c[:params]) if c.has_key?(:params)
+      end
+
+      return path, params
+    end
+  end
+end

data/lib/viki/utilities.rb

@@ -1,5 +1,8 @@
 module Viki
   module Utilities
+    URL_NAMESPACES = [:movies, :series, :episodes, :music_videos, :newscasts, :newsclips,
+                      :artists, :featured, :coming_soon, :subtitles, :hardsubs, :genres, :countries,
+                      :search, :languages]
     private
 
     def capture(response)

data/lib/viki/version.rb

@@ -1,3 +1,3 @@
 module Viki
-  VERSION = "0.0.5"
+  VERSION = "1.0.0"
 end

data/spec/lib/client_spec.rb

@@ -2,25 +2,19 @@ require 'spec_helper'
 
 describe Viki::Client do
 
-  describe "#get" do
+  describe "method delegation" do
     before { Viki::Client.any_instance.stub(:auth_request) }
-    subject { Viki::Client.new('chickenrice', 'soronerychickenrice') }
 
-    it "should perform a request to the right url given a call chain" do
-      subject.movies(1234).subtitles('en')
-      subject.should_receive(:request).with([{ :name => :movies, :resource => 1234 },
-                                             { :name => :subtitles, :resource => "en" }])
-      subject.get
+    def client
+      Viki::Client.new('chickenrice', 'soronerychickenrice')
     end
 
-    it "should perform a request with the right params given a call chain" do
-      subject.movies(1234, {genre: 2})
-      subject.should_receive(:request).with([{ :name => :movies, :resource => 1234, :params => {genre: 2}}])
-      subject.get
+    it "should raise NoMethodError error if part of the call chain is not part of the URL_NAMESPACES list" do
+      expect { client.methodwrong.subtitles('en') }.to raise_error(NoMethodError)
     end
 
-    it "should raise NoMethodError error if part of the call chain is not part of the URL_NAMESPACES list" do
-      expect { subject.methodwrong.subtitles('en') }.to raise_error(NoMethodError)
+    it "should return a request object when method_missing is called" do
+      client.movies(1234).should be_an_instance_of(Viki::Request)
     end
   end
 end

data/spec/lib/request_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe Viki::Request do
+  describe "#get" do
+    before do
+      Viki::Client.any_instance.stub(:auth_request)
+      Viki::Request.any_instance.stub(:request) { Viki::APIObject }
+    end
+
+    def client
+      Viki.new('chickenrice', 'soronerychickenrice')
+    end
+
+    it "should perform a request to the right url given a call chain" do
+      req = client.movies(1234).subtitles('en')
+      req.should_receive(:request).with([{ :name => :movies, :resource => 1234 },
+                                             { :name => :subtitles, :resource => "en" }])
+      req.get
+    end
+
+    it "should perform a request with the right params given a call chain" do
+      req = client.movies(1234, { genre: 2 })
+      req.should_receive(:request).with([{ :name => :movies, :resource => 1234, :params => { genre: 2 } }])
+      req.get
+    end
+
+    it "should raise NoMethodError error if part of the call chain is not part of the URL_NAMESPACES list" do
+      expect { client.methodwrong.subtitles('en') }.to raise_error(NoMethodError)
+    end
+  end
+end

data/spec/requests/{request_spec.rb → request_integration_spec.rb}

@@ -128,7 +128,7 @@ describe "Viki" do
       end
     end
 
-    describe "Renew Expired Access Token" do
+    describe "Access token renewal" do
       it "should request a new access token when an endpoint returns 401 and client currently has an access_token" do
         VCR.use_cassette "auth/expired_access_token" do
           client.access_token.should_not be_empty

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: viki
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -11,11 +11,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-04 00:00:00.000000000Z
+date: 2012-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70100608348400 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -23,10 +23,15 @@ dependencies:
         version: 2.10.0
   type: :development
   prerelease: false
-  version_requirements: *70100608348400
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.10.0
 - !ruby/object:Gem::Dependency
   name: vcr
-  requirement: &70100608347900 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -34,10 +39,15 @@ dependencies:
         version: 2.2.2
   type: :development
   prerelease: false
-  version_requirements: *70100608347900
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.2.2
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70100608347440 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -45,10 +55,15 @@ dependencies:
         version: 1.8.7
   type: :development
   prerelease: false
-  version_requirements: *70100608347440
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.7
 - !ruby/object:Gem::Dependency
   name: excon
-  requirement: &70100608346980 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -56,10 +71,15 @@ dependencies:
         version: 0.9.6
   type: :development
   prerelease: false
-  version_requirements: *70100608346980
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.6
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &70100608346520 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -67,10 +87,15 @@ dependencies:
         version: 0.8.3
   type: :runtime
   prerelease: false
-  version_requirements: *70100608346520
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.3
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &70100608346060 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -78,7 +103,12 @@ dependencies:
         version: 1.3.6
   type: :runtime
   prerelease: false
-  version_requirements: *70100608346060
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.6
 description: Viki-gem is an official wrapper gem for the Viki V3 API.
 email:
 - engineering@viki.com
@@ -97,11 +127,13 @@ files:
 - lib/viki/client.rb
 - lib/viki/error.rb
 - lib/viki/request.rb
+- lib/viki/transport.rb
 - lib/viki/utilities.rb
 - lib/viki/version.rb
 - spec/lib/client_spec.rb
 - spec/lib/error_spec.rb
-- spec/requests/request_spec.rb
+- spec/lib/request_spec.rb
+- spec/requests/request_integration_spec.rb
 - spec/spec_config.rb.sample
 - spec/spec_helper.rb
 - spec/support/filter_shared_examples_spec.rb
@@ -127,14 +159,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: viki
-rubygems_version: 1.8.6
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: A thin wrapper around the Viki V3 API
 test_files:
 - spec/lib/client_spec.rb
 - spec/lib/error_spec.rb
-- spec/requests/request_spec.rb
+- spec/lib/request_spec.rb
+- spec/requests/request_integration_spec.rb
 - spec/spec_config.rb.sample
 - spec/spec_helper.rb
 - spec/support/filter_shared_examples_spec.rb