fanart_api 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0cc51d31ba7daa204e738fa4f2b17b6a958aa2c3
-  data.tar.gz: e6f60127a92926645c8513b1e4413255ca6bff03
+  metadata.gz: fb1a89e7dd959723e7d8858d0c62adbb23adbd8a
+  data.tar.gz: c1024c52abcacb924cdcae44aefe3b45596f34d7
 SHA512:
-  metadata.gz: a056d1dde47a823944baf30359604ae61988ccc431a650d0b0426ccc688c2277d6815e1abb98f04648c916753df606ba9545a4b3e2e3c075e7f8c7e9dd25133b
-  data.tar.gz: 31f209ac4d5de3b42bb9f310c6f0a63af832bc5d05cfcc77ed2f646e69b7b8e007d87289cf111f33ef9428ead5326cd6a04c64f2bf33d76c9ed55f26362e1a62
+  metadata.gz: 3bee85b645cf8cba13c2d1e63af1c9ef8e35ac358efdeb9619ef78071cfffdd7d253a0b6357afe8761c378add72b686493d9e5ed4096d4ab3d43ab3904d190f8
+  data.tar.gz: ba3e2106f429644761c2f7567b27dc4a649281d8a23df2a1802a361e6af0a6d9c8615152e7cf9cc9d26eb80e4c716888440c009ebe5f92c5edc542bc362788e1

data/README.md

@@ -2,6 +2,7 @@
 [![Dependency Status](https://gemnasium.com/wafcio/fanart_api.png)](https://gemnasium.com/wafcio/fanart_api)
 [![Code Climate](https://codeclimate.com/github/wafcio/fanart_api.png)](https://codeclimate.com/github/wafcio/fanart_api)
 [![Coverage Status](https://coveralls.io/repos/wafcio/fanart_api/badge.png)](https://coveralls.io/r/wafcio/fanart_api)
+[![Gem Version](https://badge.fury.io/rb/fanart_api.png)](http://badge.fury.io/rb/fanart_api)
 
 # FanartApi
 
@@ -28,7 +29,7 @@ The generator will install an initializer where you must past your api_key.
 There is one entry point, in initialize you can past hash with api_key value, or leave empty:
 
 ```ruby
-client = FanartApi::Client.new('API_KEY')
+client = FanartApi::Client.new(api_key: 'API_KEY')
 ```
 
 ## Usage

data/fanart_api.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency 'confiture', '>= 0.1.4'
   spec.add_runtime_dependency 'httparty', '>= 0.12.0'
+  spec.add_runtime_dependency 'uri_template', '~> 0.6.0'
 
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake'

data/lib/fanart_api/base.rb

@@ -1,4 +1,5 @@
 require 'httparty'
+require 'uri_template'
 
 class FanartApi::Base
   include HTTParty
@@ -6,13 +7,41 @@ class FanartApi::Base
 
   def initialize(client)
     @client = client
+    @params = {}
   end
 
-  def api_key
-    @client.api_key
+  def get(uri)
+    @uri_template = URITemplate.new(uri)
+
+    self
+  end
+
+  def params(options)
+    @params = options
+
+    self
+  end
+
+  def response
+    @uri_template ? self.class.get(uri, body: @options) : nil
+  end
+
+  def prepare_uri
+    @uri_template ? @uri_template.expand(@params.merge(api_key: @client.api_key)) : nil
+  end
+
+  def uri
+    uri = prepare_uri
+    @params.reject!{ |param| restful_param_keys(uri).include?(param.to_s) }
+
+    uri
+  end
+
+  def restful_param_keys(uri_expanded)
+    @uri_template.extract(uri_expanded).keys
   end
 
-  def shared_uri(id, type, sort, limit)
-    "/#{api_key}/#{id}/json/#{type}/#{sort}/#{limit}"
+  def shared_uri
+    '{api_key}/{id}/json/{type}/{sort}/{limit}'
   end
 end

data/lib/fanart_api/client.rb

@@ -3,8 +3,8 @@ require 'httparty'
 class FanartApi::Client
   attr_reader :api_key
 
-  def initialize(api_key = nil)
-    @api_key = api_key ? api_key : FanartApi::Configuration.api_key
+  def initialize(options = {})
+    @api_key = options[:api_key] ? options[:api_key] : FanartApi::Configuration.api_key
   end
 
   def movie

data/lib/fanart_api/movie.rb

@@ -1,10 +1,10 @@
 # documentation: http://fanart.tv/api-docs/movie-api
 class FanartApi::Movie < FanartApi::Base
   def find(id, type = 'all', sort = '1', limit = '2')
-    self.class.get("movie#{shared_uri(id, type, sort, limit)}")
+    get("movies/#{shared_uri}").params(id: id, type: type, sort: sort, limit: limit).response
   end
 
   def update(timestamp = (Time.now - 172800).to_i)
-    self.class.get("newmovies/#{api_key}/#{timestamp}")
+    get('newmovies/{api_key}/{timestamp}').params(timestamp: timestamp).response
   end
 end

data/lib/fanart_api/music.rb

@@ -2,11 +2,11 @@
 class FanartApi::Music < FanartApi::Base
   [:artist, :album, :label].each do |method_name|
     define_method(method_name) do |id, type = 'all', sort = '1', limit = '2'|
-      self.class.get("#{method_name}#{shared_uri(id, type, sort, limit)}")
+      get("#{method_name}/#{shared_uri}").params(id: id, type: type, sort: sort, limit: limit).response
     end
   end
 
   def update(timestamp = (Time.now - 172800).to_i)
-    self.class.get("newmusic/#{api_key}/#{timestamp}")
+    get('newmusic/{api_key}/{timestamp}').params(timestamp: timestamp).response
   end
 end

data/lib/fanart_api/tv.rb

@@ -1,10 +1,10 @@
 # documentation: http://fanart.tv/api-docs/tv-api
 class FanartApi::Tv < FanartApi::Base
   def find(id, type = 'all', sort = '1', limit = '2')
-    self.class.get("series#{shared_uri(id, type, sort, limit)}")
+    get("series/#{shared_uri}").params(id: id, type: type, sort: sort, limit: limit).response
   end
 
   def update(timestamp = (Time.now - 172800).to_i)
-    self.class.get("newtv/#{api_key}/#{timestamp}")
+    get('newtv/{api_key}/{timestamp}').params(timestamp: timestamp).response
   end
 end

data/lib/fanart_api/version.rb

@@ -1,3 +1,3 @@
 module FanartApi
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/spec/fanart_api/base_spec.rb

@@ -7,21 +7,68 @@ describe FanartApi::Base do
   let(:klass) { ExampleClass }
   let(:model) { klass.new(FanartApi::Client.new) }
 
-  describe '.api_key' do
-    it 'should use default api_key' do
-      model.api_key.should == FanartApi::Configuration.api_key
+  describe '.get' do
+    it 'should set @uri_template' do
+      model.get('http://example.com')
+
+      model.instance_variable_get('@uri_template').class.should == URITemplate::RFC6570
+    end
+
+    it 'should return self' do
+      model.get('http://example.com').should == model
+    end
+  end
+
+  describe '.params' do
+    it 'should set @params' do
+      model.params(sample: 'test')
+
+      model.instance_variable_get('@params').should == { sample: 'test' }
+    end
+
+    it 'should return self' do
+      model.params(sample: 'test').should == model
+    end
+  end
+
+  describe '.response' do
+    it 'should call get klass method' do
+      model.instance_variable_set('@uri_template', URITemplate.new('{api_key}/series/{id}'))
+      klass.should_receive(:get)
+
+      model.response
+    end
+  end
+
+  describe '.prepare_uri' do
+    it 'should receive correct uri string' do
+      model.instance_variable_set('@uri_template', URITemplate.new('{api_key}/series/{id}'))
+
+      model.prepare_uri.should == "#{FanartApi::Configuration.api_key}/series/"
+    end
+  end
+
+  describe '.uri' do
+    it 'should receive correct uri string' do
+      model.instance_variable_set('@uri_template', URITemplate.new('{api_key}/series/{id}'))
+      model.instance_variable_set('@params', id: '1234')
+
+      model.uri.should == "#{FanartApi::Configuration.api_key}/series/1234"
     end
+  end
+
+  describe '.restful_param_keys' do
+    it 'should receive correct uri string' do
+      uri_template = URITemplate.new('{api_key}/series/{id}')
+      model.instance_variable_set('@uri_template', uri_template)
 
-    it 'should set api_key' do
-      klass.new(FanartApi::Client.new('API_KEY')).api_key.should == 'API_KEY'
+      model.restful_param_keys(uri_template.expand).sort.should == ['api_key', 'id'].sort
     end
   end
 
   describe '.shared_uri' do
     it 'should return correct string' do
-      model.stub(:api_key).and_return('API_KEY')
-
-      model.shared_uri('ID', 'TYPE', 'SORT', 'LIMIT').should == "/API_KEY/ID/json/TYPE/SORT/LIMIT"
+      model.shared_uri.should == '{api_key}/{id}/json/{type}/{sort}/{limit}'
     end
   end
 end

data/spec/fanart_api/movie_spec.rb

@@ -3,20 +3,31 @@ require 'spec_helper'
 describe FanartApi::Movie do
   let(:klass) { FanartApi::Movie }
   let(:model) { klass.new(FanartApi::Client.new) }
+  let(:mock_model) { SampleModel.new }
 
   describe '.find' do
-    it 'should call get with specific uri' do
-      model.stub(:api_key).and_return('API_KEY')
-      klass.should_receive(:get).with('movie/API_KEY/1234/json/all/1/2')
+    it 'should call get with specific params' do
+      model.should_receive(:get).with('movies/{api_key}/{id}/json/{type}/{sort}/{limit}').and_return(mock_model)
 
-      model.find(1234)
+      model.find('1234')
+    end
+
+    it 'should call params with specific params' do
+      model.should_receive(:params).with(id: '1234', type: 'all', sort: '1', limit: '2').and_return(mock_model)
+
+      model.find('1234')
     end
   end
 
   describe '.update' do
-    it 'should call get with specific uri' do
-      model.stub(:api_key).and_return('API_KEY')
-      klass.should_receive(:get).with('newmovies/API_KEY/1234')
+    it 'should call get with specific params' do
+      model.should_receive(:get).with('newmovies/{api_key}/{timestamp}').and_return(mock_model)
+
+      model.update(1234)
+    end
+
+    it 'should call params with specific params' do
+      model.should_receive(:params).with(timestamp: 1234).and_return(mock_model)
 
       model.update(1234)
     end

data/spec/fanart_api/music_spec.rb

@@ -3,38 +3,59 @@ require 'spec_helper'
 describe FanartApi::Music do
   let(:klass) { FanartApi::Music }
   let(:model) { klass.new(FanartApi::Client.new) }
+  let(:mock_model) { SampleModel.new }
 
   describe '.artist' do
-    it 'should call get with specific uri' do
-      model.stub(:api_key).and_return('API_KEY')
-      klass.should_receive(:get).with('artist/API_KEY/1234/json/all/1/2')
+    it 'should call get with specific params' do
+      model.should_receive(:get).with('artist/{api_key}/{id}/json/{type}/{sort}/{limit}').and_return(mock_model)
 
-      model.artist(1234)
+      model.artist('1234')
+    end
+
+    it 'should call params with specific params' do
+      model.should_receive(:params).with(id: '1234', type: 'all', sort: '1', limit: '2').and_return(mock_model)
+
+      model.artist('1234')
     end
   end
 
   describe '.album' do
-    it 'should call get with specific uri' do
-      model.stub(:api_key).and_return('API_KEY')
-      klass.should_receive(:get).with('album/API_KEY/1234/json/all/1/2')
+    it 'should call get with specific params' do
+      model.should_receive(:get).with('album/{api_key}/{id}/json/{type}/{sort}/{limit}').and_return(mock_model)
 
-      model.album(1234)
+      model.album('1234')
+    end
+
+    it 'should call params with specific params' do
+      model.should_receive(:params).with(id: '1234', type: 'all', sort: '1', limit: '2').and_return(mock_model)
+
+      model.album('1234')
     end
   end
 
   describe '.label' do
-    it 'should call get with specific uri' do
-      model.stub(:api_key).and_return('API_KEY')
-      klass.should_receive(:get).with('label/API_KEY/1234/json/all/1/2')
+    it 'should call get with specific params' do
+      model.should_receive(:get).with('label/{api_key}/{id}/json/{type}/{sort}/{limit}').and_return(mock_model)
 
-      model.label(1234)
+      model.label('1234')
+    end
+
+    it 'should call params with specific params' do
+      model.should_receive(:params).with(id: '1234', type: 'all', sort: '1', limit: '2').and_return(mock_model)
+
+      model.label('1234')
     end
   end
 
   describe '.update' do
-    it 'should call get with specific uri' do
-      model.stub(:api_key).and_return('API_KEY')
-      klass.should_receive(:get).with('newmusic/API_KEY/1234')
+    it 'should call get with specific params' do
+      model.should_receive(:get).with('newmusic/{api_key}/{timestamp}').and_return(mock_model)
+
+      model.update(1234)
+    end
+
+    it 'should call params with specific params' do
+      model.should_receive(:params).with(timestamp: 1234).and_return(mock_model)
 
       model.update(1234)
     end

data/spec/fanart_api/tv_spec.rb

@@ -3,20 +3,31 @@ require 'spec_helper'
 describe FanartApi::Tv do
   let(:klass) { FanartApi::Tv }
   let(:model) { klass.new(FanartApi::Client.new) }
+  let(:mock_model) { SampleModel.new }
 
   describe '.find' do
-    it 'should call get with specific uri' do
-      model.stub(:api_key).and_return('API_KEY')
-      klass.should_receive(:get).with('series/API_KEY/1234/json/all/1/2')
+    it 'should call get with specific params' do
+      model.should_receive(:get).with('series/{api_key}/{id}/json/{type}/{sort}/{limit}').and_return(mock_model)
 
-      model.find(1234)
+      model.find('1234')
+    end
+
+    it 'should call params with specific params' do
+      model.should_receive(:params).with(id: '1234', type: 'all', sort: '1', limit: '2').and_return(mock_model)
+
+      model.find('1234')
     end
   end
 
   describe '.update' do
-    it 'should call get with specific uri' do
-      model.stub(:api_key).and_return('API_KEY')
-      klass.should_receive(:get).with('newtv/API_KEY/1234')
+    it 'should call get with specific params' do
+      model.should_receive(:get).with('newtv/{api_key}/{timestamp}').and_return(mock_model)
+
+      model.update(1234)
+    end
+
+    it 'should call params with specific params' do
+      model.should_receive(:params).with(timestamp: 1234).and_return(mock_model)
 
       model.update(1234)
     end

data/spec/spec_helper.rb

@@ -9,5 +9,18 @@ FanartApi::Configuration.configure do |config|
   config.api_key = ''
 end
 
+class SampleModel
+  def get(uri)
+    self
+  end
+
+  def params(options = {})
+    self
+  end
+
+  def response
+  end
+end
+
 RSpec.configure do |config|
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fanart_api
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Krzysztof Wawer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-15 00:00:00.000000000 Z
+date: 2013-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: confiture
@@ -38,6 +38,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: 0.12.0
+- !ruby/object:Gem::Dependency
+  name: uri_template
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement