tvdb_client 0.1.0

data/spec/support/fixtures/responses/series_episodes_query_airedSeason.json

@@ -0,0 +1,41 @@
+{
+    "errors": null,
+    "links": {
+        "first": 1,
+        "last": 1,
+        "next": null,
+        "prev": null
+    },
+    "data": [
+        {
+            "absoluteNumber": "749",
+            "airedEpisodeNumber": 6,
+            "airedSeason": "15",
+            "dvdEpisodeNumber": null,
+            "dvdSeason": null,
+            "episodeName": "Jostling for the Junior Cup!",
+            "firstAired": "2012-08-02",
+            "id": 4359831,
+            "language": {
+                "episodeName": "en",
+                "overview": "en"
+            },
+            "overview": "Ash and his friends arrive in Lacunosa Town for the Junior Cup. The Cup begins with an exhibition match between Cynthia and Caitlyn. Iris and Georgia face off against each other but Iris’ newly caught Dragonite refuses to listen to Iris’ commands."
+        },
+        {
+            "absoluteNumber": null,
+            "airedEpisodeNumber": 6,
+            "airedSeason": "15",
+            "dvdEpisodeNumber": null,
+            "dvdSeason": null,
+            "episodeName": "Battling on thin ice!",
+            "firstAired": "2013-11-14",
+            "id": 4709580,
+            "language": {
+                "episodeName": "en",
+                "overview": "en"
+            },
+            "overview": "Ash challenges Viola to a rematch, now ready for Surskit's freezing strategy. "
+        }
+    ]
+}

data/spec/support/fixtures/responses/series_episodes_query_params.json

@@ -0,0 +1,12 @@
+{
+  "data": [
+    "airedSeason",
+    "airedEpisode",
+    "seriesId",
+    "imdbId",
+    "dvdSeason",
+    "dvdEpisode",
+    "absoluteNumber",
+    "page"
+  ]
+}

data/spec/support/fixtures/responses/series_episodes_summary.json

@@ -0,0 +1,26 @@
+{
+  "data": {
+    "airedSeasons": [
+      "12",
+      "1",
+      "2",
+      "0",
+      "3",
+      "4",
+      "5",
+      "6",
+      "7",
+      "8",
+      "14",
+      "9",
+      "10",
+      "11",
+      "13",
+      "15",
+      "16"
+    ],
+    "airedEpisodes": "923",
+    "dvdSeasons": [],
+    "dvdEpisodes": "0"
+  }
+}

data/spec/support/fixtures/responses/series_filter.json

@@ -0,0 +1,5 @@
+{
+    "data": {
+        "seriesName": "Pokémon"
+    }
+}

data/spec/support/fixtures/responses/series_filter_params.json

@@ -0,0 +1,27 @@
+{
+    "data": {
+        "params": [
+            "id",
+            "seriesName",
+            "banner",
+            "status",
+            "runtime",
+            "lastUpdated",
+            "zap2itId",
+            "aliases",
+            "seriesId",
+            "actors",
+            "airsDayOfWeek",
+            "imdbId",
+            "added",
+            "firstAired",
+            "network",
+            "genre",
+            "overview",
+            "rating",
+            "addedBy",
+            "networkId",
+            "airsTime"
+        ]
+    }
+}

data/spec/support/fixtures/responses/series_images.json

@@ -0,0 +1,9 @@
+{
+  "data": {
+    "fanart": 11,
+    "poster": 9,
+    "season": 59,
+    "seasonwide": 2,
+    "series": 7
+  }
+}

data/spec/support/fixtures/responses/series_images_query.json

@@ -0,0 +1,35 @@
+{
+    "data": [
+        {
+            "id": 24665,
+            "keyType": "fanart",
+            "subKey": "",
+            "fileName": "fanart/original/76703-1.jpg",
+            "resolution": "1280x720",
+            "ratingsInfo": {
+                "average": 6
+            }
+        },
+        {
+            "id": 42154,
+            "keyType": "fanart",
+            "subKey": "",
+            "fileName": "fanart/original/76703-2.jpg",
+            "resolution": "1280x720",
+            "ratingsInfo": {
+                "average": 6.2
+            }
+        },
+        {
+            "id": 42155,
+            "keyType": "fanart",
+            "subKey": "",
+            "fileName": "fanart/original/76703-3.jpg",
+            "resolution": "1280x720",
+            "ratingsInfo": {
+                "average": 6.375
+            }
+        }
+    ],
+    "errors": null
+}

data/spec/support/fixtures/responses/series_images_query_params.json

@@ -0,0 +1,60 @@
+{
+    "data": [
+        {
+            "keyType": "fanart",
+            "resolution": [
+                "1920x1080",
+                "1280x720"
+            ],
+            "subKey": [
+                "graphical",
+                "text"
+            ]
+        },
+        {
+            "keyType": "poster",
+            "resolution": "680x1000",
+            "subKey": null
+        },
+        {
+            "keyType": "season",
+            "resolution": null,
+            "subKey": [
+                "13",
+                "7",
+                "6",
+                "5",
+                "4",
+                "3",
+                "2",
+                "1",
+                "14",
+                "15",
+                "8",
+                "9",
+                "10",
+                "16",
+                "12",
+                "11",
+                "0"
+            ]
+        },
+        {
+            "keyType": "seasonwide",
+            "resolution": null,
+            "subKey": [
+                "10",
+                "1"
+            ]
+        },
+        {
+            "keyType": "series",
+            "resolution": null,
+            "subKey": [
+                "graphical",
+                "blank",
+                "text"
+            ]
+        }
+    ]
+}

data/spec/support/fixtures/settings.example.yml

@@ -0,0 +1,6 @@
+---
+tvdb:
+  host_url: https://api.thetvdb.com
+  username: foo
+  password: bar
+  api_key:  123abc

data/spec/support/shared_contexts/authentication.rb

@@ -0,0 +1,13 @@
+require 'rspec'
+require 'spec_helper'
+
+shared_context "Authentication" do
+  include_context "Credentials"
+  include_context "Connection"
+  
+  def authenticate_connection
+    valid_creds[:connection] = connection
+
+    TVDB::Authorization.new( valid_creds ).login
+  end
+end

data/spec/support/shared_contexts/connection.rb

@@ -0,0 +1,20 @@
+require 'rspec'
+require 'spec_helper'
+
+shared_context "Connection" do
+  let( :connection_options ) {
+    {
+      host_url: "https://api.thetvdb.localhost.com"
+    }
+  }
+
+  let( :connection ) {
+    TVDB::Connection.new( host_url: connection_options[:host_url] )
+  }
+
+  def authenticate_connection
+    valid_creds[:connection] = connection
+
+    TVDB::Authorization.new( valid_creds ).login
+  end
+end

data/spec/support/shared_contexts/credentials.rb

@@ -0,0 +1,20 @@
+require 'rspec'
+require 'spec_helper'
+
+shared_context "Credentials" do
+  let( :valid_creds ) {
+    {
+      :username   => "validuser",
+      :userpass   => "validpass",
+      :apikey     => "validapikey"
+    }
+  }
+
+  let( :invalid_creds ) {
+    {
+      :username   => "invaliduser",
+      :userpass   => "invalidpass",
+      :apikey     => "invalidapikey"
+    }
+  }
+end

data/spec/support/shared_contexts/series_subclass.rb

@@ -0,0 +1,19 @@
+require 'rspec'
+require 'spec_helper'
+
+shared_context "Series Subclass" do
+  include_context "Authentication"
+
+  before( :each ) do
+    authenticate_connection
+  end
+
+  let( :series_id  ) { '76703' }
+
+  let( :series_opts ) {
+    {
+      connection: connection,
+      series_id:  series_id,
+    }
+  }
+end

data/spec/tvdb_client/authorization_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+require 'json'
+
+describe "TVDB::Authorization" do
+
+  include_context "Connection"
+  include_context "Credentials"
+
+  let( :valid_init_options ) {
+    valid_creds[:connection] = connection
+    valid_creds
+  }
+
+  let( :invalid_init_options ) {
+    invalid_creds[:connection] = connection
+    invalid_creds
+  }
+
+  subject { TVDB::Authorization.new( valid_init_options ) }
+
+  describe "initialization" do
+    it "should create a TVDB::Authorization object" do
+      expect( subject ).to be_a_kind_of( TVDB::Authorization )
+    end
+    
+    it "should have a connection accessor" do
+      expect( subject ).to respond_to( :connection )
+      
+      subject.connection.token = "pudding"
+      expect( subject.connection.token ).to eq( "pudding" )
+    end
+  end
+
+  describe "Authentication" do
+    context 'Logging in' do
+      it "should be able to log in" do
+        expect( subject ).to respond_to( :login )
+      end
+
+      it "should set a token on the connection object upon successful login" do
+        subject.login
+
+        expect( subject.connection.token ).to be_a_kind_of( String )
+        expect( subject.connection.token.length > 1 ).to be( true )
+      end
+
+      it "should not set a token upon failed login" do
+        failure = TVDB::Authorization.new( invalid_init_options )
+        failure.login
+
+        expect( failure.connection.token.length > 1 ).to be( false )
+        expect( failure.login.code ).to be( 401 )
+      end
+    end
+
+    context 'Refreshing tokens' do
+      it "should refresh a valid token" do
+        subject.login
+        old_token = subject.connection.token
+
+        subject.refresh_token
+        new_token = subject.connection.token
+
+        expect( old_token ).not_to eq( new_token )
+      end
+    end
+  end
+  
+end

data/spec/tvdb_client/client_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+require 'json'
+
+describe "TVDB::Client" do
+
+  include_context "Credentials"
+  
+  subject { TVDB::Client.new( valid_creds ) }
+
+  describe "Initialization" do
+    it "should require user credentials" do
+      expect { TVDB::Client.new( invalid_creds ) }.to raise_error( RuntimeError )
+    end
+
+    it "should authenticate the user and set a token" do
+      expect( subject.connection.token ).to be_a_kind_of( String )
+    end
+
+    it "should set an auth accessor" do
+      expect( subject.auth ).to be_a_kind_of( TVDB::Authorization )
+    end
+  end
+
+  describe "Authentication" do
+    it "should refresh the user's token" do
+      old_token = subject.connection.token
+      subject.refresh_token
+
+      expect( subject.connection.token ).not_to eq( old_token )
+    end
+  end
+
+  describe "Functionality" do
+    context 'Series' do
+      it "should return a series object" do
+        pokemon = subject.series( '76703')
+
+        expect( pokemon ).to be_a_kind_of( TVDB::Series )
+        expect( pokemon.data ).to be_a_kind_of( Hash )
+        expect( pokemon.data ).to have_key( "data" )
+      end
+    end
+  end
+
+end

data/spec/tvdb_client/connection_spec.rb

@@ -0,0 +1,159 @@
+require 'spec_helper'
+require 'json'
+
+describe "TVDB::Connection" do
+
+  include_context "Connection"
+
+  let( :convenience_headers ) {
+    {:language => "derp", :version => "12345", :modified_since => "Tuesday"}
+  } 
+
+  subject { TVDB::Connection.new( connection_options ) }
+
+  describe "Initialization" do
+
+    it "should createa a connection and set attrs" do
+      expect( subject.connection ).to be_a_kind_of( Faraday::Connection )
+      expect( subject.host_url   ).to eq( connection_options[:host_url] )
+      expect( subject.token      ).to eq( "" )
+    end
+
+    it "should setup a Response struct" do
+      expect( subject.response_struct ).to be_a_kind_of( Class )
+    end
+ 
+  end
+
+  describe "Ancillary operations" do
+
+    context 'headers' do
+      it "should set default headers for requests" do
+        expect( subject.set_default_headers( {} ) ).to be_a_kind_of( Hash )
+        expect( subject.set_default_headers( {} )["Content-Type"] ).to eq( "application/json" )
+        expect( subject.set_default_headers( {} )["Authorization"] ).to eq( "Bearer " )
+      end
+
+      it "should override default headers " do
+        custom_header = { :headers => { "Content-Type" => "text/html" } }
+
+        expect( subject.set_default_headers( custom_header )["Content-Type"] ).to eq( "text/html" )
+      end
+
+      it "should apply custom headers" do
+        custom_header = { :headers => { "howdy" => "g'day mate" } }
+
+        expect( subject.set_default_headers( custom_header )["howdy"] ).to eq( "g'day mate" )
+      end
+
+      it "should set the langauge or version if passed in" do
+        subject.set_convenience_headers( convenience_headers )
+
+        expect( subject.language ).to eq( "derp" )
+        expect( subject.version ).to eq( "12345" )
+        expect( subject.modified_since ).to eq( "Tuesday" )
+      end
+    end
+
+    context 'responses' do
+      let( :route    ) { "/login" }
+      let( :response ) { subject.post( route, body: {} ) }
+
+      it "should store responses in a struct" do
+        expect( response ).to be_a_kind_of( Struct )
+      end
+
+      it "should set a code accessor" do
+        expect( response ).to respond_to( :code )
+        expect( response.code ).to eq( 401 )
+      end
+
+      it "should set a body accessor" do
+        expect( response ).to respond_to( :body )
+        expect( response.body ).to eq( {"Error"=>"API Key Required"} )
+      end
+
+      it "should set a headers accessor" do
+        expect( response ).to respond_to( :headers )
+        expect( response.headers ).to be_a_kind_of( Hash )
+      end
+
+      it "should set a request_url accessor" do
+        expect( response ).to respond_to( :request_url )
+        expect( response.request_url ).to eq( "#{connection_options[:host_url]}#{route}")
+      end
+    end
+  end
+
+  describe "REST operations" do
+    include_context "Credentials"
+
+    describe 'POSTing' do
+
+      let( :post_params ) {
+        {
+          :body => { :bacon => "tasty" }
+        }
+      }
+
+      it "should be able to POST json to a route" do
+        expect( subject ).to respond_to( :post )
+      end
+
+      context 'Authorized requests' do
+        let( :successful_post ) {
+          subject.post( '/login', body: valid_creds )
+        }
+
+        it "should return a 200 upon successful POST" do
+          expect( successful_post.code ).to be( 200 )
+        end
+
+        it "should return response headers" do
+          expect( successful_post.headers["content-type"] ).to eq( "application/json" )
+        end
+      end
+
+      context 'Unauthorized requests' do
+        it "should return a 401 if unathorized" do
+          expect( subject.post( '/login', post_params ).code ).to be( 401 )
+        end
+      end
+
+    end
+
+    describe "GETing" do
+      it "should be able to GET a route" do
+        expect( subject ).to respond_to( :get )
+      end
+
+      it "should take optional parameters" do
+        param_req = subject.get( '/series/1234', :page => 1 )
+        expect( param_req.request_url ).to match( 'page=1' )
+      end
+
+      it "should override existing convenience headers" do
+        subject.get( '/series/1234', convenience_headers )
+
+        convenience_headers.each do |accessor, value|
+          expect( subject.send( accessor ) ).to eq( value )
+        end
+      end
+
+      context 'Unauthorized requests' do
+        it "should return a 401 if unathorized" do
+          expect( subject.get( '/series/1234' ).code ).to be( 401 )
+        end
+      end
+
+      context '304 response' do
+        it "should an empty body for a 304 (not modified) response" do
+          expect( subject.get( '/not/modified' ).code ).to be( 304 )
+          expect( subject.get( '/not/modified' ).body ).to be( nil )
+        end
+      end
+    end
+    
+  end
+
+end