fanart_api 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 87290847861add7f96f125086e81788561a040c8
-  data.tar.gz: 121bd4d1b3031347bff6a48e13c78989c4e5ec12
+  metadata.gz: 1f051fccf4b6b3ef7ef55291a8ef381a0a0fb5a8
+  data.tar.gz: 90110694c1bf982f7b3d956a8dd1d7e143bcce8a
 SHA512:
-  metadata.gz: 121cb8ca1c63423d01d1c3afe1ae635885f72e8c2a11145dab494e6cfedd210512812fa225feebc9a3a5d2d179944ee1332dc962b2ee1724aa5d413536fffbd5
-  data.tar.gz: 11566f7c858173aa35d028921627c8b243a80b706c6de55a28fa1719920445e44357c8502c00d312c92fdaaf71ec21300526084e3f3d86dfd35ac751e244db13
+  metadata.gz: ad47c30a859bd6001982736e351bddb1d7eefe14fce201b6e02a37af9a7f4237978a0a92066e2dbd85758bcc4a89c2315f66e3c6a90043b8d4c8f02c06800896
+  data.tar.gz: 44112006eccf4dc66800c719886dcc86b3f3c71755b927321a3bd092bb59ea01f35fe97ad4f38baa0d2d315962aee7dde5d2d3375eb48e4353bc931adef0fdfc

data/.gitignore

@@ -1,19 +1,6 @@
 *.gem
-*.rbc
-.bundle
-.config
-.yardoc
 Gemfile.lock
-InstalledFiles
-_yardoc
 coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
 
-spec/integrations/support/fanart_api.rb
+spec/integrations/support/fanart_api.rb
+spec/support/api_key.rb

data/.travis.yml

@@ -3,4 +3,5 @@ script: 'bundle exec rspec spec/functionals'
 rvm:
   - 1.9.3
   - 2.0.0
-  - 2.1.0
+  - 2.1.5
+  - 2.2.0

data/CHANGELOG.md

@@ -0,0 +1,31 @@
+## 0.3.0 (January 25, 2015)
+
+  - use ov gem for multimethod
+  - fix test for rspec 3 syntax
+  - add more tests
+
+## 0.2.1 (September 3, 2014)
+
+  - fix gemspec dependency
+
+## 0.2.0 (July 18, 2014)
+
+  - use APIv3
+
+## 0.1.3 (June 28, 2014)
+
+  - fix for default options
+
+## 0.1.2 (June 28, 2014)
+
+  - refactored
+  - replaced HTTParty by Faraday
+
+## 0.0.2 (December 17, 2013)
+
+  - little performance improvement
+  - used uri_template for better way to format uri and map variables
+
+## 0.0.1 (December 15, 2013)
+
+First release with HTTParty

data/README.md

@@ -1,63 +1,96 @@
-[![Build Status](https://travis-ci.org/wafcio/fanart_api.png?branch=master)](https://travis-ci.org/wafcio/fanart_api)
-[![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)
+[![Build Status](https://travis-ci.org/tvapi/fanart_api.png?branch=master)](https://travis-ci.org/tvapi/fanart_api)
+[![Dependency Status](https://gemnasium.com/tvapi/fanart_api.png)](https://gemnasium.com/tvapi/fanart_api)
+[![Code Climate](https://codeclimate.com/github/tvapi/fanart_api.png)](https://codeclimate.com/github/tvapi/fanart_api)
+[![Coverage Status](https://coveralls.io/repos/tvapi/fanart_api/badge.png)](https://coveralls.io/r/tvapi/fanart_api)
 [![Gem Version](https://badge.fury.io/rb/fanart_api.png)](http://badge.fury.io/rb/fanart_api)
 
 # FanartApi
 
-Ruby client for fanart.tv API
+fanart_api is a simple ruby client for accessing TV shows information from the fanart.tv API.
 
-fanart.tv APIv2 - FanartApi gem v0.1.x (lastest v0.1.3)
-fanart.tv APIv3 - FanartApi gem v0.2.x (from v0.2.0)
+## Installation
 
-## Getting started
-
-You can add it to your Gemfile with:
+With Bundler:
 
 ```ruby
-gem 'fanart_api'
+gem 'thetvdb_api'
 ```
 
-## How to use
-
-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: 'API_KEY')
+$ bundle install
 ```
 
-Optional you can add option proxy: false which will not send request to proxy.
+Otherwhise:
 
 ```ruby
-client = FanartApi::Client.new(api_key: 'API_KEY', proxy: false)
+$ gem install thetvdb_api
 ```
 
-## Usage
+## How to use
 
-Movie API
+You have two way for access to api:
 
 ```ruby
-client.movie.find(id: id)
-client.movie.latest(date: 1...)
+client = FanartApi::Client.new(api_key: '...')
 ```
+```ruby
+client = FanartApi::Client.new(api_key: '...', proxy_url: '...')
+client.movie # => #<FanartApi::Movie>
+client.music # => #<FanartApi::Music>
+client.tv # => #<FanartApi::Tv>
+```
+
+* II case (direct access to api class, many entry points)
 
-Music API
+Language attribute is required
 
 ```ruby
-client.music.artist(id: id)
-client.music.album(id: id)
-client.music.label(id: id)
-client.music.latest(date: 1...)
+ThetvdbApi::Actor.new(api_key: '...')
+ThetvdbApi::Banner.new(api_key: '...')
+ThetvdbApi::Episode.new(api_key: '...')
 ```
 
-Tv API
-
 ```ruby
-client.tv.find(id: id)
-client.tv.latest(date: 1...)
+ThetvdbApi::Actor.new(api_key: '...', proxy_url: '...')
+ThetvdbApi::Banner.new(api_key: '...', proxy_url: '...')
+ThetvdbApi::Episode.new(api_key: '...', proxy_url: '...')
 ```
 
+## Methods
+
+For all methods you can pass hash attributes or multiple attributes specified in method comment.
+
+### Movie methods
+
+For method attributes read https://github.com/tvapi/fanart_api/blob/master/lib/fanart_api/movie.rb
+
+* find
+* find_url
+* latest
+* latest_url
+
+### Music methods
+
+For method attributes read https://github.com/tvapi/fanart_api/blob/master/lib/fanart_api/music.rb
+
+* artist
+* artist_url
+* album
+* album_url
+* label
+* label_url
+* latest
+* latest_url
+
+### Tv methods
+
+For method attributes read https://github.com/tvapi/fanart_api/blob/master/lib/fanart_api/tv.rb
+
+* find
+* find_url
+* latest
+* latest_url
+
 ## Contributing
 
 1. Fork it

data/fanart_api.gemspec

@@ -18,10 +18,12 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'service_api', '0.0.4'
+  spec.add_runtime_dependency 'service_api', '~> 0.1.0'
+  spec.add_runtime_dependency 'ov', '~> 0.1.0'
 
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec', '>= 2.14.1'
-  spec.add_development_dependency 'coveralls', '>= 0.7'
+  spec.add_development_dependency 'rspec', '~> 3.1.0'
+  spec.add_development_dependency 'coveralls', '~> 0.7'
+  spec.add_development_dependency 'awesome_print', '~> 1.6.0'
 end

data/lib/fanart_api.rb

@@ -1,3 +1,5 @@
+require 'ov'
+
 module FanartApi; end
 
 require 'fanart_api/version'

data/lib/fanart_api/base.rb

@@ -4,7 +4,7 @@ class FanartApi::Base
   include ServiceApi::BaseFaraday
 
   def api_key_options
-    { api_key: @client.options[:api_key] }
+    { api_key: @config[:api_key] }
   end
 
   def path_with_params(path, options)
@@ -26,10 +26,10 @@ class FanartApi::Base
   end
 
   def base_url
-    if @client.options[:proxy] == false
-      'http://webservice.fanart.tv/v3/'
+    if @config[:proxy_url]
+      @config[:proxy_url]
     else
-      'http://fanarttv.apiary-proxy.com/v3/'
+      'http://webservice.fanart.tv/v3/'
     end
   end
 end

data/lib/fanart_api/client.rb

@@ -1,21 +1,21 @@
 class FanartApi::Client
-  attr_reader :options
+  attr_reader :config
 
-  def initialize(options = {})
-    @options = options
+  def initialize(config = {})
+    @config = config
 
-    @options[:adapter] ||= :net_http
+    @config[:adapter] ||= :net_http
   end
 
   def movie
-    @movie ||= FanartApi::Movie.new(self)
+    @movie ||= FanartApi::Movie.new(config)
   end
 
   def music
-    @music ||= FanartApi::Music.new(self)
+    @music ||= FanartApi::Music.new(config)
   end
 
   def tv
-    @tv ||= FanartApi::Tv.new(self)
+    @tv ||= FanartApi::Tv.new(config)
   end
 end

data/lib/fanart_api/movie.rb

@@ -1,18 +1,110 @@
-# documentation: http://fanart.tv/api-docs/movie-api
 class FanartApi::Movie < FanartApi::Base
-  def find(options = {})
+  include Ov
+
+  # Find specific movie data.
+  #
+  # access: FREE
+  # param:
+  #   find(1234)
+  # output: Faraday::Response instance with Hash body
+  # example: http://docs.fanarttv.apiary.io/#movies
+  let :find, Any do |id|
+    find(id: id)
+  end
+
+
+  # Find specific movie data.
+  #
+  # access: FREE
+  # param:
+  #   find(id: 1234)
+  # output: Faraday::Response instance with Hash body
+  # example: http://docs.fanarttv.apiary.io/#movies
+  let :find, Hash do |options|
     find_path_with_params(options).get
   end
 
-  def find_url(options = {})
+  # Find specific movie data - return only url.
+  #
+  # access: FREE
+  # param:
+  #   find_url(1234)
+  # output: url string
+  let :find_url, Any do |id|
+    find_url(id: id)
+  end
+
+  # Find specific movie data - return only url.
+  #
+  # access: FREE
+  # param:
+  #   find_url(id: 1234)
+  # output: url string
+  let :find_url, Hash do |options|
     find_path_with_params(options).url
   end
 
-  def latest(options = {})
+  # Get latest movies data.
+  #
+  # access: FREE
+  # param:
+  #   latest
+  # output: Faraday::Response instance with Array body
+  # example: http://docs.fanarttv.apiary.io/#movies
+  let :latest do |date|
+    latest({})
+  end
+
+  # Get latest movies data.
+  #
+  # access: FREE
+  # param:
+  #   latest(1234)
+  # output: Faraday::Response instance with Array body
+  # example: http://docs.fanarttv.apiary.io/#movies
+  let :latest, Any do |date|
+    latest(date: date)
+  end
+
+
+  # Get latest movies data.
+  #
+  # access: FREE
+  # param:
+  #   latest(date: 1234)
+  # output: Faraday::Response instance with Array body
+  # example: http://docs.fanarttv.apiary.io/#movies
+  let :latest, Hash do |options|
     latest_path_with_params(options).get
   end
 
-  def latest_url(options = {})
+  # Get latest movies data - return only url.
+  #
+  # access: FREE
+  # param:
+  #   latest_url
+  # output: url string
+  let :latest_url do |date|
+    latest_url({})
+  end
+
+  # Get latest movies data - return only url.
+  #
+  # access: FREE
+  # param:
+  #   latest_url(1234)
+  # output: url string
+  let :latest_url, Any do |date|
+    latest_url(date: date)
+  end
+
+  # Get latest movies data - return only url.
+  #
+  # access: FREE
+  # param:
+  #   latest_url(date: 1234)
+  # output: url string
+  let :latest_url, Hash do |options|
     latest_path_with_params(options).url
   end
 

data/lib/fanart_api/music.rb

@@ -1,34 +1,192 @@
-# documentation: http://fanart.tv/api-docs/music-api
 class FanartApi::Music < FanartApi::Base
-  def artist(options = {})
+  include Ov
+
+  # Find specific artist data.
+  #
+  # access: FREE
+  # param:
+  #   artist(1234)
+  # output: Faraday::Response instance with Hash body
+  # example: http://docs.fanarttv.apiary.io/#music
+  let :artist, Any do |id|
+    artist(id: id)
+  end
+
+  # Find specific artist data.
+  #
+  # access: FREE
+  # param:
+  #   artist(id: 1234)
+  # output: Faraday::Response instance with Hash body
+  # example: http://docs.fanarttv.apiary.io/#music
+  let :artist, Hash do |options|
     artist_path_with_params(options).get
   end
 
-  def artist_url(options = {})
+  # Find specific artist data - return only url.
+  #
+  # access: FREE
+  # param:
+  #   artist_url(1234)
+  # output: url string
+  let :artist_url, Any do |id|
+    artist_url(id: id)
+  end
+
+  # Find specific artist data - return only url.
+  #
+  # access: FREE
+  # param:
+  #   artist_url(id: 1234)
+  # output: url string
+  let :artist_url, Hash do |options|
     artist_path_with_params(options).url
   end
 
-  def album(options = {})
+  # Find specific album data.
+  #
+  # access: FREE
+  # param:
+  #   album(1234)
+  # output: Faraday::Response instance with Hash body
+  # example: http://docs.fanarttv.apiary.io/#music
+  let :album, Any do |id|
+    album(id: id)
+  end
+
+  # Find specific album data.
+  #
+  # access: FREE
+  # param:
+  #   album(id: 1234)
+  # output: Faraday::Response instance with Hash body
+  # example: http://docs.fanarttv.apiary.io/#music
+  let :album, Hash do |options|
     album_path_with_params(options).get
   end
 
-  def album_url(options = {})
+  # Find specific album data - return only url.
+  #
+  # access: FREE
+  # param:
+  #   album_url(1234)
+  # output: url string
+  let :album_url, Any do |id|
+    album_url(id: id)
+  end
+
+  # Find specific album data - return only url.
+  #
+  # access: FREE
+  # param:
+  #   album_url(id: 1234)
+  # output: url string
+  let :album_url, Hash do |options|
     album_path_with_params(options).url
   end
 
-  def label(options = {})
+  # Find specific label data.
+  #
+  # access: FREE
+  # param:
+  #   label(1234)
+  # output: Faraday::Response instance with Hash body
+  # example: http://docs.fanarttv.apiary.io/#music
+  let :label, Any do |id|
+    label(id: id)
+  end
+
+  # Find specific label data.
+  #
+  # access: FREE
+  # param:
+  #   label(id: 1234)
+  # output: Faraday::Response instance with Hash body
+  # example: http://docs.fanarttv.apiary.io/#music
+  let :label, Hash do |options|
     label_path_with_params(options).get
   end
 
-  def label_url(options = {})
+  # Find specific label data - return only url.
+  #
+  # access: FREE
+  # param:
+  #   label_url(1234)
+  # output: url string
+  let :label_url, Any do |id|
+    label_url(id: id)
+  end
+
+  # Find specific label data - return only url.
+  #
+  # access: FREE
+  # param:
+  #   label_url(id: 1234)
+  # output: url string
+  let :label_url, Hash do |options|
     label_path_with_params(options).url
   end
 
-  def latest(options = {})
+  # Get latest artists data.
+  #
+  # access: FREE
+  # param:
+  #   latest
+  # output: Faraday::Response instance with Array body
+  # example: http://docs.fanarttv.apiary.io/#tv
+  let :latest do |date|
+    latest({})
+  end
+
+  # Get latest artists data.
+  #
+  # access: FREE
+  # param:
+  #   latest(1234)
+  # output: Faraday::Response instance with Array body
+  # example: http://docs.fanarttv.apiary.io/#tv
+  let :latest, Any do |date|
+    latest(date: date)
+  end
+
+  # Get latest artists data.
+  #
+  # access: FREE
+  # param:
+  #   latest(date: 1234)
+  # output: Faraday::Response instance with Array body
+  # example: http://docs.fanarttv.apiary.io/#tv
+  let :latest, Hash do |options|
     latest_path_with_params(options).get
   end
 
-  def latest_url(options = {})
+  # Get latest artists data - return only url.
+  #
+  # access: FREE
+  # param:
+  #   latest_url
+  # output: url string
+  let :latest_url do |date|
+    latest_url({})
+  end
+
+  # Get latest artists data - return only url.
+  #
+  # access: FREE
+  # param:
+  #   latest_url(1234)
+  # output: url string
+  let :latest_url, Any do |date|
+    latest_url(date: date)
+  end
+
+  # Get latest artists data - return only url.
+  #
+  # access: FREE
+  # param:
+  #   latest_url(date: 1234)
+  # output: url string
+  let :latest_url, Hash do |options|
     latest_path_with_params(options).url
   end