fanart_api 0.0.1

checksums.yaml

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

data/.gitignore

@@ -0,0 +1,19 @@
+*.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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+script: 'bundle exec rspec spec/fanart_api'
+rvm:
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fanart_api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Krzysztof Wawer
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,65 @@
+[![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)
+
+# FanartApi
+
+Ruby client for fanart.tv API
+
+## Getting started
+
+You can add it to your Gemfile with:
+
+```ruby
+gem 'fanart_api'
+```
+
+Run the bundle command to install it.
+
+```console
+rails generate fanart_api:install
+```
+
+The generator will install an initializer where you must past your api_key.
+
+## 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')
+```
+
+## Usage
+
+Movie API
+
+```ruby
+client.movie.find(id, type = 'all', sort = '1', limit = '2')
+client.movie.update(timestamp)
+```
+
+Music API
+
+```ruby
+client.music.artist(id, type = 'all', sort = '1', limit = '2')
+client.music.album(id, type = 'all', sort = '1', limit = '2')
+client.music.label(id, type = 'all', sort = '1', limit = '2')
+client.music.update(timestamp)
+```
+
+Tv API
+
+```ruby
+client.tv.find(id, type = 'all', sort = '1', limit = '2')
+client.tv.update(timestamp)
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/fanart_api.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fanart_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'fanart_api'
+  spec.version       = FanartApi::VERSION
+  spec.authors       = ['Krzysztof Wawer']
+  spec.email         = ['krzysztof.wawer@gmail.com']
+  spec.description   = %q{Ruby client for fanart.tv API}
+  spec.summary       = %q{Ruby client for fanart.tv API}
+  spec.homepage      = %q{http://github.com/wafcio/fanart_api}
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'confiture', '>= 0.1.4'
+  spec.add_runtime_dependency 'httparty', '>= 0.12.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'
+end

data/lib/fanart_api.rb

@@ -0,0 +1,9 @@
+module FanartApi; end
+
+require 'fanart_api/version'
+require 'fanart_api/configuration'
+require 'fanart_api/base'
+require 'fanart_api/movie'
+require 'fanart_api/music'
+require 'fanart_api/tv'
+require 'fanart_api/client'

data/lib/fanart_api/base.rb

@@ -0,0 +1,18 @@
+require 'httparty'
+
+class FanartApi::Base
+  include HTTParty
+  base_uri 'http://api.fanart.tv/webservice//'
+
+  def initialize(client)
+    @client = client
+  end
+
+  def api_key
+    @client.api_key
+  end
+
+  def shared_uri(id, type, sort, limit)
+    "/#{api_key}/#{id}/json/#{type}/#{sort}/#{limit}"
+  end
+end

data/lib/fanart_api/client.rb

@@ -0,0 +1,21 @@
+require 'httparty'
+
+class FanartApi::Client
+  attr_reader :api_key
+
+  def initialize(api_key = nil)
+    @api_key = api_key ? api_key : FanartApi::Configuration.api_key
+  end
+
+  def movie
+    @movie ||= FanartApi::Movie.new(self)
+  end
+
+  def music
+    @music ||= FanartApi::Music.new(self)
+  end
+
+  def tv
+    @tv ||= FanartApi::Tv.new(self)
+  end
+end

data/lib/fanart_api/configuration.rb

@@ -0,0 +1,7 @@
+require 'confiture'
+
+class FanartApi::Configuration
+  include Confiture::Configuration
+
+  confiture_allowed_keys(:api_key)
+end

data/lib/fanart_api/movie.rb

@@ -0,0 +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)}")
+  end
+
+  def update(timestamp = (Time.now - 172800).to_i)
+    self.class.get("newmovies/#{api_key}/#{timestamp}")
+  end
+end

data/lib/fanart_api/music.rb

@@ -0,0 +1,12 @@
+# documentation: http://fanart.tv/api-docs/music-api
+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)}")
+    end
+  end
+
+  def update(timestamp = (Time.now - 172800).to_i)
+    self.class.get("newmusic/#{api_key}/#{timestamp}")
+  end
+end

data/lib/fanart_api/tv.rb

@@ -0,0 +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)}")
+  end
+
+  def update(timestamp = (Time.now - 172800).to_i)
+    self.class.get("newtv/#{api_key}/#{timestamp}")
+  end
+end

data/lib/fanart_api/version.rb

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

data/lib/generators/fanart_api/install_generator.rb

@@ -0,0 +1,12 @@
+module FanartApi
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('../../templates', __FILE__)
+
+      desc 'Creates a FanartApi::Configuration initializer and copy locale files to your application.'
+      def copy_initializer
+        template 'fanart_api.rb', 'config/initializers/fanart_api.rb'
+      end
+    end
+  end
+end

data/lib/generators/templates/fanart_api.rb

@@ -0,0 +1,3 @@
+FanartApi::Configuration.configure do |config|
+  config.api_key = ''
+end

data/spec/fanart_api/base_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+class ExampleClass < FanartApi::Base
+end
+
+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
+    end
+
+    it 'should set api_key' do
+      klass.new(FanartApi::Client.new('API_KEY')).api_key.should == 'API_KEY'
+    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"
+    end
+  end
+end

data/spec/fanart_api/client_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe FanartApi::Client do
+  let(:model) { FanartApi::Client.new }
+
+  describe '.movie' do
+    it 'should return movie class' do
+      model.movie.class.should == FanartApi::Movie
+    end
+  end
+
+  describe '.music' do
+    it 'should return music class' do
+      model.music.class.should == FanartApi::Music
+    end
+  end
+
+  describe '.tv' do
+    it 'should return tv class' do
+      model.tv.class.should == FanartApi::Tv
+    end
+  end
+end

data/spec/fanart_api/movie_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe FanartApi::Movie do
+  let(:klass) { FanartApi::Movie }
+  let(:model) { klass.new(FanartApi::Client.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')
+
+      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')
+
+      model.update(1234)
+    end
+  end
+end

data/spec/fanart_api/music_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe FanartApi::Music do
+  let(:klass) { FanartApi::Music }
+  let(:model) { klass.new(FanartApi::Client.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')
+
+      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')
+
+      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')
+
+      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')
+
+      model.update(1234)
+    end
+  end
+end

data/spec/fanart_api/tv_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe FanartApi::Tv do
+  let(:klass) { FanartApi::Tv }
+  let(:model) { klass.new(FanartApi::Client.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')
+
+      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')
+
+      model.update(1234)
+    end
+  end
+end

data/spec/integration_spec_helper.rb

@@ -0,0 +1,3 @@
+require 'spec_helper'
+
+require File.join(File.dirname(__FILE__), 'integrations/support/fanart_api.rb')

data/spec/integrations/movie_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe FanartApi::Movie do
+  let(:klass) { FanartApi::Movie }
+  let(:model) { klass.new(FanartApi::Client.new) }
+
+  describe '.find' do
+    it 'should return response class' do
+      model.find('tt0120737').class.should == HTTParty::Response
+    end
+  end
+
+  describe '.update' do
+    it 'should call get with specific uri' do
+      model.update.class.should == HTTParty::Response
+    end
+  end
+end

data/spec/integrations/music_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe FanartApi::Music do
+  let(:klass) { FanartApi::Music }
+  let(:model) { klass.new(FanartApi::Client.new) }
+
+  describe '.artist' do
+    it 'should return response class' do
+      model.artist('f4a31f0a-51dd-4fa7-986d-3095c40c5ed9').class.should == HTTParty::Response
+    end
+  end
+
+  describe '.album' do
+    it 'should return response class' do
+      model.album('f4a31f0a-51dd-4fa7-986d-3095c40c5ed9').class.should == HTTParty::Response
+    end
+  end
+
+  describe '.label' do
+    it 'should return response class' do
+      model.label('f4a31f0a-51dd-4fa7-986d-3095c40c5ed9').class.should == HTTParty::Response
+    end
+  end
+
+  describe '.update' do
+    it 'should call get with specific uri' do
+      model.update.class.should == HTTParty::Response
+    end
+  end
+end

data/spec/integrations/support/fanart_api.rb.example

@@ -0,0 +1,3 @@
+FanartApi::Configuration.configure do |config|
+  config.api_key = ''
+end

data/spec/integrations/tv_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe FanartApi::Tv do
+  let(:klass) { FanartApi::Tv }
+  let(:model) { klass.new(FanartApi::Client.new) }
+
+  describe '.find' do
+    it 'should return response class' do
+      model.find('70346').class.should == HTTParty::Response
+    end
+  end
+
+  describe '.update' do
+    it 'should call get with specific uri' do
+      model.update.class.should == HTTParty::Response
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'coveralls'
+Coveralls.wear!
+
+require 'fanart_api'
+
+FanartApi::Configuration.configure do |config|
+  config.api_key = ''
+end
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification
+name: fanart_api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Krzysztof Wawer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: confiture
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.1.4
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0.7'
+description: Ruby client for fanart.tv API
+email:
+- krzysztof.wawer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fanart_api.gemspec
+- lib/fanart_api.rb
+- lib/fanart_api/base.rb
+- lib/fanart_api/client.rb
+- lib/fanart_api/configuration.rb
+- lib/fanart_api/movie.rb
+- lib/fanart_api/music.rb
+- lib/fanart_api/tv.rb
+- lib/fanart_api/version.rb
+- lib/generators/fanart_api/install_generator.rb
+- lib/generators/templates/fanart_api.rb
+- spec/fanart_api/base_spec.rb
+- spec/fanart_api/client_spec.rb
+- spec/fanart_api/movie_spec.rb
+- spec/fanart_api/music_spec.rb
+- spec/fanart_api/tv_spec.rb
+- spec/integration_spec_helper.rb
+- spec/integrations/movie_spec.rb
+- spec/integrations/music_spec.rb
+- spec/integrations/support/fanart_api.rb.example
+- spec/integrations/tv_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/wafcio/fanart_api
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.0
+signing_key: 
+specification_version: 4
+summary: Ruby client for fanart.tv API
+test_files:
+- spec/fanart_api/base_spec.rb
+- spec/fanart_api/client_spec.rb
+- spec/fanart_api/movie_spec.rb
+- spec/fanart_api/music_spec.rb
+- spec/fanart_api/tv_spec.rb
+- spec/integration_spec_helper.rb
+- spec/integrations/movie_spec.rb
+- spec/integrations/music_spec.rb
+- spec/integrations/support/fanart_api.rb.example
+- spec/integrations/tv_spec.rb
+- spec/spec_helper.rb