tvdb_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9d967e40fe2780d81db44abf2f4c5569e57c7e60
+  data.tar.gz: 26a36dc25cfab7e293a0c80047be339ef68eea7a
+SHA512:
+  metadata.gz: bffccb169a9e9d98f4f14e41a366c1fd6f029080523deb9ec4fd3861139cd754142998a7ee953b195dbbf972a79e47515681418f6c51fb10cbc0bd67e938c576
+  data.tar.gz: 4f3d0b9b1d232427f98c9b2fb0c385aa345c7f101610f67d1f1e67052fe18808a9f9d3d67b9c23162e22f14e91b5772b11ccdfe8e3a9c0310d8edd0cc32219a5

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.sw[a-p]
+.Trashes
+._*
+.bundle
+.config
+.yardoc
+bundle/
+Desktop.ini
+Gemfile.lock
+Session.vim
+_yardoc
+auto-save-list
+coverage
+doc
+lib/bundler/man
+pkg
+pkg/*
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.rubyversion

@@ -0,0 +1 @@
+2.2.0

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# Changelog
+
+## 0.1.0
+Initial release of the `tvdb_client` rubygem.

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/Guardfile

@@ -0,0 +1,20 @@
+notification :terminal_notifier
+
+guard 'spork' do
+  watch('Gemfile')
+  watch('Gemfile.lock')
+  watch('spec/spec_helper.rb') { :rspec }
+end
+
+params = {
+  wait:           60,
+  all_after_pass: false,
+  all_on_start:   true,
+  cmd: "bundle exec rspec"
+}
+
+guard 'rspec', cmd: 'bundle exec rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb})             { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')         { "spec" }
+end

data/README.md

@@ -0,0 +1,43 @@
+# tvdb_client
+
+`tvdb_client` is a rubygem to interface with The TVDB's REST API.
+
+## Installation
+
+This gem has not yet been published on rubygems.org. For now, you will have to  
+download and build the gem from source. I will publish the gem once it is in  
+a releaseable state.
+
+```sh
+$ git clone git@github.com:awlunsfo/tvdb_client.git
+$ cd tvdb_client
+$ gem build tvdb_client.gemspec
+```
+
+## Usage
+
+See the Wiki for usage details.
+
+## License
+
+The MIT License (MIT)
+
+Copyright (c) [year] [fullname]
+
+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/Rakefile

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'semantic'
+require 'highline/import'
+require 'settingslogic'
+
+require_relative 'lib/tvdb_client'
+require_relative "lib/tvdb_client/settings"
+
+Dir.glob('tasks/*.rake').each { |r| load r}

data/conf/settings.example.yml

@@ -0,0 +1,7 @@
+---
+tvdb:
+  apikey: 123abc
+  username: biz
+  userpass: baz
+  host_url: https://api.thetvdb.localhost.com
+  api_version: 1.2.0

data/lib/tvdb_client.rb

@@ -0,0 +1,13 @@
+require_relative "tvdb_client/authorization"
+require_relative "tvdb_client/client"
+require_relative "tvdb_client/connection"
+require_relative "tvdb_client/settings"
+require_relative "tvdb_client/series"
+require_relative "tvdb_client/series/base"
+require_relative "tvdb_client/series/series_episodes"
+require_relative "tvdb_client/series/series_images"
+require_relative "tvdb_client/series/series_filter"
+require_relative "tvdb_client/version"
+
+module TVDB
+end

data/lib/tvdb_client/authorization.rb

@@ -0,0 +1,46 @@
+module TVDB
+
+  class Authorization
+
+    attr_reader   :username, :password, :api_key
+    attr_accessor :connection
+
+    def initialize( options )
+      @username    = options.fetch( :username )   { nil }
+      @password    = options.fetch( :userpass )   { nil }
+      @api_key     = options.fetch( :apikey )     { Settings.tvdb.apikey   }
+      @connection  = options.fetch( :connection )
+    end
+
+    def login
+      credentials = {
+        :username => username, 
+        :userpass => password,
+        :apikey   => api_key
+      }
+
+      response = connection.post( "/login", body: credentials )
+
+      handle_response( response )
+    end
+
+    def refresh_token
+      response = connection.get( '/refresh_token' )
+
+      handle_response( response )
+    end
+
+    private
+
+    def handle_response( response )
+      if response.code != 200
+        connection.token = ""
+      else
+        connection.token = response.body["token"]
+      end
+
+      return response
+    end
+
+  end
+end

data/lib/tvdb_client/client.rb

@@ -0,0 +1,30 @@
+module TVDB
+  class Client
+    attr_accessor :connection
+    attr_reader   :auth
+
+    def initialize( options )
+      authenticate( options )
+    end
+
+    def refresh_token
+      auth.refresh_token
+    end
+
+    def series( series_id, options = {} )
+      TVDB::Series.new( connection, series_id, options )
+    end
+
+    private
+
+    def authenticate( options )
+      @connection          = TVDB::Connection.new( options )
+      options[:connection] = connection
+      @auth                = TVDB::Authorization.new( options )
+
+      login = auth.login
+
+      raise "#{login}" if login.code == 401
+    end
+  end
+end

data/lib/tvdb_client/connection.rb

@@ -0,0 +1,98 @@
+module TVDB
+  class Connection
+    require "faraday"
+    require "json"
+
+    attr_accessor :token, :response_struct, :language, :version, :modified_since
+    attr_reader   :connection, :host_url
+
+    def initialize( options = {} )
+      @token           = ""
+      
+      @host_url        = options.fetch( :host_url ) { Settings.tvdb.host_url }
+      @language        = options[:language]
+      @version         = options[:version]
+      @modified_since  = options[:modified_since]
+
+      @connection      = Faraday.new( :url => host_url, :ssl => { :verify => false } )
+      @response_struct = Struct.new( :request_url, :code, :body, :headers )
+    end
+
+    def post( route, options )
+      request_body = options.fetch( :body )
+
+      response = connection.post do |req|
+        req.url( route )
+        req.headers = set_default_headers( options )
+        req.body    = request_body.to_json
+      end
+
+      return parsed_response( response )
+    end
+
+    def get( route, options = {} )
+      params, headers = parse_options( options )
+
+      response = connection.get do |req|
+        req.url( route )
+        req.headers = headers
+        req.params  = params
+      end
+
+      return parsed_response( response )
+    end
+
+    def parse_options( options )
+      headers = set_default_headers( options )
+      params  = set_params( options )
+
+      return params, headers
+    end
+
+    def set_params( options )
+      [:language, :version, :modified_since, :headers].each do |param|
+        options.delete_if { |key, value| key == param }
+      end
+
+      return options
+    end
+
+    def set_default_headers( options )
+      set_convenience_headers( options )
+
+      headers = options[:headers] if options
+      headers ||= {}
+
+      headers["Authorization"]     ||= "Bearer #{token}"
+      headers["Content-Type"]      ||= "application/json"
+      headers["Accept-Language"]   ||= "#{language}"
+      headers["Accept"]            ||= "application/vnd.thetvdb.v#{version}"
+      headers["If-Modified-Since"] ||= "#{modified_since}"
+
+      return headers
+    end
+
+    def set_convenience_headers( options )
+      if options
+        @language       = options[:language]
+        @version        = options[:version]
+        @modified_since = options[:modified_since]
+      end
+    end
+
+    def parsed_response( response )
+      unless response.body.empty?
+        body = JSON.parse( response.body )
+      else
+        body = nil
+      end
+
+      response_struct.new(
+        "#{host_url}#{response.env.url.request_uri}",
+        response.status,
+        body,
+        response.env.response_headers
+      )
+    end
+  end
+end

data/lib/tvdb_client/series.rb

@@ -0,0 +1,54 @@
+module TVDB
+  class Series
+    attr_accessor :connection
+    attr_reader   :data, :route, :series_id, :code, :params
+
+    def initialize( connection, series_id, options = {} )
+      @connection = connection
+      @series_id  = series_id
+      @route      = "/series/#{series_id}"
+
+      set_subtype_parameters
+      get_series( series_id, options )
+    end
+
+    def episodes( options = {} )
+      set_subtype_parameters( options )
+
+      TVDB::Series::Episodes.new( params )
+    end
+
+    def images( options = {} )
+      set_subtype_parameters( options )
+
+      TVDB::Series::Images.new( params )
+    end
+
+    def filter( options = {} )
+      set_subtype_parameters( options )
+
+      TVDB::Series::Filter.new( params )
+    end
+
+    def all_episodes
+      tr = TVDB::Service::Threading::ThreadedRequest.new( connection: connection )
+      tr.make_request( "#{route}/episodes" )
+    end
+
+    private
+
+    def get_series( series_id, options = {} )
+      series = connection.get( route, options )
+      @data  = series.body
+      @code  = series.code
+    end
+
+    def set_subtype_parameters( options = {} )
+      @params = {
+        connection: connection, 
+        series_id: series_id,
+        params: options
+      }      
+    end
+  end
+end

data/lib/tvdb_client/series/base.rb

@@ -0,0 +1,32 @@
+module TVDB
+  class Series
+    class Base
+
+      attr_reader   :series_id, :data, :route
+      attr_accessor :connection, :parameters
+
+      def initialize
+        abstract_method
+      end
+
+      def list
+        connection.get( route, parameters ).body
+      end
+
+      def query( options )
+        connection.get( "#{route}/query", options ).body
+      end
+
+      def query_params
+        connection.get( "#{route}/query/params" ).body
+      end
+
+      private
+
+      def abstract_method
+        raise Exception, "#{self.class}: This method needs to be implemented in the concrete class"
+      end
+
+    end
+  end
+end

data/lib/tvdb_client/series/series_episodes.rb

@@ -0,0 +1,18 @@
+module TVDB
+  class Series
+    class Episodes < TVDB::Series::Base
+
+      def initialize( options )
+        @connection = options.fetch( :connection )
+        @series_id  = options.fetch( :series_id )
+        @parameters = options.fetch( :params ) { {} }
+        @route      = "/series/#{series_id}/episodes"
+      end
+
+      def summary
+        connection.get( "#{route}/summary" ).body
+      end
+
+    end
+  end
+end

data/lib/tvdb_client/series/series_filter.rb

@@ -0,0 +1,21 @@
+module TVDB
+  class Series
+    class Filter < TVDB::Series::Base
+
+      def initialize( options )
+        @connection = options.fetch( :connection )
+        @series_id  = options.fetch( :series_id )
+        @parameters = options.fetch( :params ) { {} }
+        @route      = "/series/#{series_id}/filter"
+      end
+
+      def params
+        connection.get( "#{route}/params" ).body
+      end
+
+      def query_params
+        raise NotImplementedError, "'.query_params' not implemented for #{self.class}. Please use '.params'"
+      end
+    end
+  end
+end