tvdb_client 0.1.0

data/spec/tvdb_client/series/base_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+require 'json'
+
+describe "TVDB::Series" do
+  include_context "Series Subclass"
+
+  describe "Initialization" do
+    it "should throw an error when trying to instantiate TVDB::Series::Base directly" do
+      expect { TVDB::Series::Base.new }.to raise_error( Exception )
+    end
+  end
+  
+end

data/spec/tvdb_client/series/series_episodes_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+require 'json'
+
+describe "TVDB::Series" do
+  include_context "Series Subclass"
+
+  subject { TVDB::Series::Episodes.new( series_opts ) }
+
+  describe "Initialization" do
+    it "should create an instance of TVDB::Series" do
+      expect( subject ).to be_a_kind_of( TVDB::Series::Episodes )
+    end
+
+    it "should set a connection and a series ID" do
+      expect( subject.connection ).to be_a_kind_of( TVDB::Connection )
+      expect( subject.series_id  ).to eq( '76703' )
+    end
+  end
+
+  describe "Episodes for a Series" do
+    context 'Listing episodes' do
+      it "should list the episodes for a series" do
+        episodes = subject.list
+        expect( episodes ).to be_a_kind_of( Hash )
+        expect( episodes["data"] ).to be_a_kind_of( Array )
+        expect( episodes["data"].length > 1 ).to be( true )
+      end
+    end
+
+    context 'Querying' do
+      it "should be able to query episodes for a series" do
+        expect( subject ).to respond_to( :query )
+      end
+
+      it "should return results that match the query" do
+        expect{ subject.query( params: { airedSeason: 15 } ) }.not_to raise_error
+        query = subject.query( params: { airedSeason: 15 } )
+
+        expect( query["data"][-1]["airedSeason"] ).to eq( "15" )
+      end
+
+      it "should return parameters to query by" do
+        expect( subject.query_params["data"] ).to be_a_kind_of( Array )
+        expect( subject.query_params["data"][0] ).to eq( "airedSeason" )
+      end
+    end
+
+    context 'Summary' do
+      it "should return a summary of episodes for the series" do
+        expect( subject.summary["data"]["airedSeasons"].length ).to eq( 17 )
+      end
+    end
+  end
+  
+end

data/spec/tvdb_client/series/series_filter_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+require 'json'
+
+describe "TVDB::Series" do
+  include_context "Series Subclass"
+
+  let( :init_opts ) {
+    series_opts[:params] = { :keys => "seriesName" }
+
+    series_opts
+  }
+
+  subject { TVDB::Series::Filter.new( init_opts ) }
+
+  describe "Initialization" do
+    it "should create an instance of TVDB::Series" do
+      expect( subject ).to be_a_kind_of( TVDB::Series::Filter )
+    end
+
+    it "should set a connection and a series ID" do
+      expect( subject.connection ).to be_a_kind_of( TVDB::Connection )
+      expect( subject.series_id  ).to eq( '76703' )
+    end
+  end
+
+  describe "Filter for a Series" do
+    it "should filter the keys returned from a /series GET" do
+      expect( subject.list ).to be_a_kind_of( Hash )
+      expect( subject.list["data"] ).to have_key( "seriesName" )
+      expect( subject.list["data"].length ).to eq( 1 )
+    end
+
+    it "should return a list of keys to filter by" do
+      response = subject.params["data"]["params"]
+
+      expect( response ).to be_a_kind_of( Array )
+      expect( response.length > 1 ).to be( true )
+    end
+
+    it "should not respond to query_params" do
+      expect { subject.query_params }.to raise_error( NotImplementedError )
+    end
+  end
+  
+end

data/spec/tvdb_client/series/series_images_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+require 'json'
+
+describe "TVDB::Series" do
+  include_context "Series Subclass"
+
+  subject { TVDB::Series::Images.new( series_opts ) }
+
+  describe "Initialization" do
+    it "should create an instance of TVDB::Series" do
+      expect( subject ).to be_a_kind_of( TVDB::Series::Images )
+    end
+
+    it "should set a connection and a series ID" do
+      expect( subject.connection ).to be_a_kind_of( TVDB::Connection )
+      expect( subject.series_id  ).to eq( '76703' )
+    end
+  end
+
+  describe "Images for a Series" do
+    it "should return a summary of images for the given series" do
+      images = subject.list
+
+      expect( images ).to be_a_kind_of( Hash )
+      ["fanart", "poster", "season", "seasonwide", "series"].each do |type|
+        expect( images["data"] ).to have_key( type )
+      end
+    end
+
+    it "should return a user query" do
+      results = subject.query( :keyType => "fanart" )
+
+      expect( results["data"][0]["keyType"] ).to eq( "fanart" )
+    end
+
+    it "should list the parameters available to query by" do
+      results = subject.query_params
+
+      expect( results["data"].length > 1 ).to be( true )
+    end
+  end
+  
+end

data/spec/tvdb_client/series_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+require 'json'
+
+describe "TVDB::Series" do
+  include_context "Authentication"
+
+  before( :each ) do
+    authenticate_connection
+  end
+
+  let( :series_id ) { '76703' }
+
+  subject { TVDB::Series.new( connection, series_id ) }
+
+  describe "Initialization" do
+    it "should create an instance of TVDB::Series" do
+      expect( subject ).to be_a_kind_of( TVDB::Series )
+    end
+
+    it "should set a connection accessor" do
+      expect( subject.connection ).to be_a_kind_of( TVDB::Connection )
+    end
+
+    it "should return series data" do
+      expect( subject.data ).to be_a_kind_of( Hash )
+      expect( subject.data["data"]["id"] ).to eq( 76703 )
+    end
+
+    it "should handle series that do not exist" do
+      bad_series = TVDB::Series.new( connection, '773747' )
+      expect( bad_series.data["Error"] ).to eq( "ID: 773747 not found" )
+    end
+  end
+
+  describe "Series Episodes" do
+    it "should return episodes in a series" do
+      expect( subject.episodes.list["data"] ).to be_a_kind_of( Array )
+      expect( subject.episodes.list["links"]["next"] ).to eq( 2 )
+    end
+
+    it "should return the 2nd page of results" do
+      result = subject.episodes( page: 2 ).list
+      expect( result["links"]["next"] ).to eq( nil )
+    end
+
+    it "should be able to return all episodes for a series" do
+      page1 = subject.episodes( page: 1 ).list["data"]
+      page2 = subject.episodes( page: 2 ).list["data"]
+
+      combined_pages = [page1, page2].flatten
+
+      expect( subject.all_episodes.length ).to eq( combined_pages.length )
+    end
+  end
+
+  describe "Series Images" do
+    it "should return images for a series" do
+      expect( subject.images ).to be_a_kind_of( TVDB::Series::Images )
+    end
+  end
+
+  describe "Series Filter" do
+    it "should return filtered results for a series" do
+      expect( subject.filter( :keys => "seriesName" ) ).to be_a_kind_of( TVDB::Series::Filter )
+      expect( subject.filter( :keys => "seriesName" ).list.length ).to eq( 1 )
+    end
+  end
+  
+end

data/spec/tvdb_client/service/threading/threaded_request_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+require 'json'
+
+describe "TVDB::Service::Threading" do
+  include_context "Authentication"
+
+  let(:init_options) { 
+    {
+      connection: connection,
+      pool_size: 10
+    }
+  }
+
+  subject { TVDB::Service::Threading::ThreadedRequest.new( init_options ) }
+
+  describe "Initialization" do
+    it "should take arguments and set attrs" do
+      expect( subject.connection ).to be_a_kind_of( TVDB::Connection )
+      expect( subject.pool_size  ).to be_a_kind_of( Integer )
+    end
+
+    it "should default to a pool size of 10" do
+      opts = { connection: connection }
+
+      tr = TVDB::Service::Threading::ThreadedRequest.new( opts )
+      expect( tr.pool_size ).to eq( 10 )
+    end
+  end
+
+  describe "Requests" do
+    before( :each ) do
+      authenticate_connection
+    end
+
+    it "should be able to make a request" do
+      expect( subject ).to respond_to( :make_request )
+    end
+
+    it "should return an array of results" do
+      response = subject.make_request( "/series/99999/episodes" )
+
+      expect( response ).to be_a_kind_of( Array )
+      expect( response.length > 0 ).to be( true )
+    end
+
+    it "should bail if the route doesn't return a 200 response" do
+      expect( subject.make_request( "/series/12345/episodes" ).code ).to eq( 404 )
+    end
+
+    it "should limit connections to the pool size" do
+      skip "Not sure how to test this one yet"
+    end
+  end
+end

data/spec/tvdb_client/version_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+require 'json'
+
+describe "TVDB::Version" do
+
+  describe "version" do
+    it "should return the version of the API client" do
+      expect( TVDB::VERSION ).to be_a_kind_of( String )
+    end
+  end
+
+end

data/tasks/version_bump.rake

@@ -0,0 +1,102 @@
+namespace :version do
+
+  desc "Bumps up the version number by the patch level"
+  task :patch do
+    bump_version( "patch" )
+  end
+
+  desc "Bumps up the version number by a minor release level"
+  task :minor do
+    bump_version( "minor" )
+  end
+
+  desc "Bumps up the version number by a major release level"
+  task :major do
+    bump_version( "major" )
+  end
+
+  desc "TVDB's current version"
+  task :current do
+    puts TVDB::VERSION
+  end
+
+  desc "Bypass incremental bumping and set the version to whatever you specify in the format: #.#.#"
+  task :set, [:version] do |t, args|
+    raise "Version must match the following format: #.#.#" unless args[:version].match( /^[0-9].[0-9].[0-9]$/ )
+    write_version_file( args[:version] )
+  end
+
+  def bump_version( version_level )
+    current_version = Semantic::Version.new( TVDB::VERSION )
+
+    case version_level
+    when "patch"
+      current_version.patch += 1
+    when "minor"
+      current_version.minor += 1
+      current_version.patch  = 0
+    when "major"
+      current_version.major += 1
+      current_version.minor  = 0
+      current_version.patch  = 0
+
+    end
+
+    write_version_file( current_version )
+  end
+
+  def write_version_file( version )
+    yes_or_no = ask( "You are about to change tvdb_client to version: #{version}. Continue? [y/n]" )
+
+    continue?( yes_or_no )
+    create_new_version_file( version )
+    add_entry_to_changelog( version )
+  end
+
+  def continue?( yes_or_no )
+    case yes_or_no
+    when "y"
+      puts 'Continuing...'
+    when "n"
+      abort( 'Looks like you changed your mind. Exiting!' )
+    else
+      puts "Please respond with either 'y' or 'n'."
+    end
+  end
+
+  def create_new_version_file( version )
+    @new_version = version
+    template     = File.expand_path( "../../templates/version.rb.erb", __FILE__ )
+
+    erb               = ERB.new( File.read( template ) )
+    file_output       = erb.result(binding)
+    file_output_path  = File.expand_path( '../../lib/tvdb_client/version.rb', __FILE__ )
+
+    File.open( file_output_path, 'w' ) { |f| f.write( file_output ) }
+
+    message = [
+      "\nTVDB has been updated to version: #{version}!",
+      "A new entry has appeared in the CHANGELOG!",
+      " ",
+      "Please edit the new CHANGELOG entry and add it along with version.rb to the repo."
+    ].join( "\n" )
+
+    puts message
+  end
+
+  def add_entry_to_changelog( version )
+    @new_version  = version
+    chlg_temp     = "../../templates/changelog_entry_template.md.erb"
+    template      = File.expand_path( chlg_temp, __FILE__ )
+
+    erb           = ERB.new( File.read( template ) )
+    file_output   = erb.result(binding)
+    changelog     = File.expand_path( '../../CHANGELOG.md', __FILE__ )
+
+    new_changelog = File.read( changelog ).lines.insert(2, file_output)
+
+    File.open( changelog, 'w' ) { |f| f.write( new_changelog.join('') ) }
+  end
+
+
+end

data/templates/changelog_entry_template.md.erb

@@ -0,0 +1,3 @@
+## <%= @new_version %>
+Add your notes here!
+

data/templates/version.rb.erb

@@ -0,0 +1,3 @@
+module TVDB
+  VERSION = "<%= @new_version %>"
+end

data/tvdb_client.gemspec

@@ -0,0 +1,41 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tvdb_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tvdb_client"
+  spec.version       = TVDB::VERSION
+  spec.authors       = ["Aaron Lunsford"]
+  spec.email         = ["awlunsfo@gmail.com"]
+  spec.summary       = %q{Ruby client for the TVDB API}
+  spec.description   = %q{Ruby library for interacting with the TVDB's REST API}
+  spec.homepage      = "https://github.com/awlunsfo/tvdb_client.git"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_dependency 'siliconsalad-settingslogic',             '~> 2.0'
+  spec.add_dependency 'multi_json',                             '~> 1.10'
+  spec.add_dependency 'faraday',                                '~> 0.9'
+  spec.add_dependency 'rake',                                   '~> 10.1'
+  spec.add_dependency 'semantic',                               '~> 1.3'
+  spec.add_dependency 'highline',                               '~> 1.7'
+
+  spec.add_development_dependency "bundler",                    "~> 1.7"
+  spec.add_development_dependency 'guard',                      '~> 2.6'
+  spec.add_development_dependency 'guard-rspec',                '~> 4.3'
+  spec.add_development_dependency 'terminal-notifier',          '~> 1.6'
+  spec.add_development_dependency 'terminal-notifier-guard',    '~> 1.6'
+  spec.add_development_dependency 'rb-readline',                '~> 0.5'
+  spec.add_development_dependency 'pry-byebug',                 '~> 3.2'
+  spec.add_development_dependency 'guard-spork',                '~> 2.1'
+  spec.add_development_dependency 'spork',                      '~> 0.9'
+  spec.add_development_dependency 'yard',                       '~> 0.8'
+  spec.add_development_dependency 'rspec',                      '~> 3.1'
+  spec.add_development_dependency 'simplecov',                  '~> 0.9'
+  spec.add_development_dependency 'webmock',                    '~> 1.18'
+  spec.add_development_dependency 'sinatra',                    '~> 1.4'
+end