tvdbjson 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3f31635d50ebac2a73984a6a67ff90ada68e1e64
+  data.tar.gz: 556dad6d367076be42d09893689777e9a2363938
+SHA512:
+  metadata.gz: c278a1a3ad4341da93bb431bd87c328d61e4ead7fb5470f85ca417b32076b02e1a444289e55d5476158ae31cc173dd9c34c935d5faff2a61a50d4b5d7adaa509
+  data.tar.gz: e7b45149f67cc04141adc869c572bd81c78f382ce6c325861cc5df17433040e8f1507a36fba54de38983a5d319faff2bf77dd3da236cb4ba76d04f353703f2f0

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.md

@@ -0,0 +1,7 @@
+Copyright (c) 2017 Jeremy Tennant
+
+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,82 @@
+# Tvdbjson
+
+## Description
+A super-unofficial Ruby Gem for thetvdb.com ['swagger' api](https://api.thetvdb.com/swagger), please feel free to contribute!
+
+### Install the gem
+
+Visit [rubygems](https://rubygems.org/gems/thetvdbjson) for instructions on how to install this gem via the command line, or for how to include it in your gemfile.
+
+### Create some environment variables
+[Create an account](https://www.thetvdb.com/?tab=register) and [register for your API Key](https://www.thetvdb.com/?tab=apiregister) on thetvdb.com
+```
+export TVDB_API_KEY="Your API Key"
+export TVDB_USER_KEY="Your User Key"
+export TVDB_USER_NAME="Your User Name"
+```
+
+## Overview
+You're going to need to read the source for full details, as this gem is a work in progress.
+
+```
+# Create an authentication object.
+  auth = Tvdbjson::Authentication.new
+
+# An auth token lasts 24 hours, so implement this as needed
+  auth.refresh_token if auth.token_expired?
+
+# Search for a Television Series
+  search_results = Tvdbjson::Series.search_by_name("Game of Thrones", auth)
+
+# Just to make the rest of this easy, we'll store the thetvdb's result for "Game of Thrones" in a variable
+  game_of_thrones = search_results.first
+
+# By the way, this gem uses awesome_print so you can get output like this:
+
+  ap game_of_thrones
+      # => {
+      #             "id" => 121361,
+      #           "name" => "Game of Thrones",
+      #       "overview" => "Seven noble families fight for control of the mythical land of Westeros. Friction between the houses leads to full-scale war. All while a very ancient evil awakens in the farthest north. Amidst the war, a neglected military order of misfits, the Night's Watch, is all that stands between the realms of men and the icy horrors beyond.",
+      #        "network" => "HBO",
+      #         "banner" => "graphical/121361-g19.jpg",
+      #    "first_aired" => "2011-04-17",
+      #         "status" => "Continuing",
+      #        "aliases" => []
+      # }
+
+# Search for images for that Television series
+
+  search_options = { :series_id => game_of_thrones.id, :type => "fanart" }
+  image_results = Tvdbjson::Image.search_by_series(search_options, auth)
+
+  search_options = { :series_id => game_of_thrones.id, :type => "poster" }
+  image_results = Tvdbjson::Image.search_by_series(search_options, auth)
+
+  search_options = { :series_id => game_of_thrones.id, :type => "season" }
+  image_results = Tvdbjson::Image.search_by_series(search_options, auth)
+
+  search_options = { :series_id => game_of_thrones.id, :type => "seasonwide" }
+  image_results = Tvdbjson::Image.search_by_series(search_options, auth)
+
+  search_options = { :series_id => game_of_thrones.id, :type => "series" }
+  image_results = Tvdbjson::Image.search_by_series(search_options, auth)
+
+# Or perhaps just the images for Season 5 of a Television series
+  search_options = { :series_id => game_of_thrones.id, :type => "season", :subkey => 5 }
+  image_results = Tvdbjson::Image.search_by_series_and_season(search_options, auth)
+
+  search_options = { :series_id => game_of_thrones.id, :type => "fanart", :subkey => "graphical" }
+  image_results = Tvdbjson::Image.search_by_series_and_season(search_options, auth)
+
+# Search for a specific episode
+  search_query = { :series_id => game_of_thrones.id, :season_number => 6, :episode_number => 9 }
+  episode_results = Tvdbjson::Episode.search_by_season_and_episode(search_query,auth)
+
+```
+
+## License
+MIT - For terms refer to LICENSE.md
+
+## thetvdb
+The creator of this gem is in no way affiliated with thetvdb

data/lib/tvdbjson.rb

@@ -0,0 +1,12 @@
+require "httparty"
+require "awesome_print"
+require 'tvdbjson/hashable.rb'
+require 'tvdbjson/requestable.rb'
+
+Dir[File.dirname(__FILE__) + '/tvdbjson/*.rb'].each do |file|
+  require file
+end
+
+module Tvdbjson
+
+end

data/lib/tvdbjson/authentication.rb

@@ -0,0 +1,37 @@
+module Tvdbjson
+  class Authentication
+
+    attr_accessor :expiry, :token
+
+    TVDB_API_KEY   = ENV['TVDB_API_KEY']
+    TVDB_USER_KEY  = ENV['TVDB_USER_KEY']
+    TVDB_USER_NAME = ENV['TVDB_USER_NAME']
+
+    def initialize()
+      new_token
+    end
+
+    def token_expired?
+      Time.now >= @expiry
+    end
+
+    def new_token
+      @expiry = Time.now + 86400
+      @token = get_token
+    end
+
+    private
+
+      def get_token
+        options = {}
+        options[:uri] = "/login"
+        options[:body] = { "apikey" => TVDB_API_KEY, "userkey" => TVDB_USER_KEY, "username" => TVDB_USER_NAME }
+        options[:header] = {}
+
+        request = Request.new(options)
+        response = request.post
+        response.parsed_response["token"]
+      end
+
+  end
+end

data/lib/tvdbjson/episode.rb

@@ -0,0 +1,58 @@
+module Tvdbjson
+  class Episode
+    include Tvdbjson::Hashable
+    extend Tvdbjson::Requestable
+
+    attr_accessor :id, :name, :series_id, :episode_number, :season_number, :first_aired, :overview
+
+    def initialize(options = {})
+      @id             = options[:id]
+      @name           = options[:name]
+      @series_id      = options[:series_id]
+      @episode_number = options[:episode_number]
+      @season_number  = options[:season_number]
+      @first_aired    = options[:first_aired]
+      @overview       = options[:overview]
+    end
+
+    def self.search_by_season_and_episode(options = {}, authentication)
+      raise Tvdbjson::RequiredSeriesIdMissingError if !options[:series_id]
+      raise Tvdbjson::RequiredSearchParamMissingError if !options[:season_number]
+      raise Tvdbjson::RequiredSearchParamMissingError if !options[:episode_number]
+      raise Tvdbjson::AuthenticationObjectMissingError unless authentication.kind_of?(Tvdbjson::Authentication)
+
+      hash = {
+        :method       => "GET",
+        :uri          => "/series/#{options[:series_id]}/episodes/query",
+        :after_action => "Tvdbjson::Episode.from_response(response, #{options[:series_id]})",
+        :params       => { "airedSeason" => options[:season_number], "airedEpisode" => options[:episode_number] }
+      }
+      send_authenticated_request(hash, authentication)
+    end
+
+    def self.from_response(response, series_id)
+      results_array = []
+
+      begin
+        response.parsed_response["data"].each do |record|
+          hash                  = {}
+          hash[:id]             = record["id"]
+          hash[:name]           = record["episodeName"]
+          hash[:series_id]      = series_id
+          hash[:episode_number] = record["airedEpisodeNumber"]
+          hash[:season_number]  = record["airedSeasonID"]
+          hash[:first_aired]    = record["firstAired"]
+          hash[:overview]       = record["overview"]
+
+          result = Episode.new(hash)
+          results_array << result
+        end
+      rescue NoMethodError
+        # Means an empty result set was found, don't do anything special
+        # here as this method will return an empty array.
+      end
+      results_array
+    end
+
+  end
+end

data/lib/tvdbjson/error.rb

@@ -0,0 +1,7 @@
+module Tvdbjson
+  class Error < StandardError; end
+  class RequiredSearchParamMissingError < Error; end
+  class RequiredSeriesIdMissingError < Error; end
+  class InvalidImageTypeRequestedError < Error; end
+  class AuthenticationObjectMissingError < Error; end
+end

data/lib/tvdbjson/hashable.rb

@@ -0,0 +1,11 @@
+module Tvdbjson
+  module Hashable
+
+    def to_hash
+      hash = {}
+      instance_variables.each {|var| hash[var.to_s.delete("@")] = instance_variable_get(var) }
+      hash
+    end
+
+  end
+end

data/lib/tvdbjson/image.rb

@@ -0,0 +1,77 @@
+module Tvdbjson
+  class Image
+    include Tvdbjson::Hashable
+    extend Tvdbjson::Requestable
+
+    attr_accessor :id, :series_id, :url, :type, :subkey, :resolution, :rating_average, :rating_count, :thumbnail_url
+
+    def initialize(options = {})
+      @id             = options[:id]
+      @series_id      = options[:series_id]
+      @url            = options[:url]
+      @type           = options[:type]
+      @subkey         = options[:subkey]
+      @resolution     = options[:resolution]
+      @rating_average = options[:rating_average]
+      @rating_count   = options[:rating_count]
+      @thumbnail_url  = options[:thumbnail_url]
+    end
+
+    def self.search_by_series(options = {}, authentication)
+      raise Tvdbjson::RequiredSeriesIdMissingError if !options[:series_id]
+      raise Tvdbjson::RequiredSearchParamMissingError if !options[:type]
+      raise Tvdbjson::AuthenticationObjectMissingError unless authentication.kind_of?(Tvdbjson::Authentication)
+      raise Tvdbjson::InvalidImageTypeRequestedError unless %w(fanart poster season seasonwide series).include?(options[:type])
+
+      hash = {
+        :method       => "GET",
+        :uri          => "/series/#{options[:series_id]}/images/query",
+        :after_action => "Tvdbjson::Image.from_response(response, #{options[:series_id]})",
+        :params       => { "keyType" => options[:type].downcase }
+      }
+      send_authenticated_request(hash, authentication)
+    end
+
+    def self.search_by_series_and_season(options = {}, authentication)
+      raise Tvdbjson::RequiredSeriesIdMissingError if !options[:series_id]
+      raise Tvdbjson::RequiredSearchParamMissingError if !options[:subkey]
+      raise Tvdbjson::AuthenticationObjectMissingError unless authentication.kind_of?(Tvdbjson::Authentication)
+      raise Tvdbjson::InvalidImageTypeRequestedError unless %w(fanart poster season seasonwide series).include?(options[:type])
+
+      hash = {
+        :method       => "GET",
+        :uri          => "/series/#{options[:series_id]}/images/query",
+        :after_action => "Tvdbjson::Image.from_response(response, #{options[:series_id]})",
+        :params       => { "keyType" => options[:type].downcase, "subKey" => options[:subkey] }
+      }
+      send_authenticated_request(hash, authentication)
+    end
+
+    def self.from_response(response, series_id)
+      results_array = []
+
+      begin
+        response.parsed_response["data"].each do |record|
+          hash                  = {}
+          hash[:id]             = record["id"]
+          hash[:series_id]      = series_id
+          hash[:url]            = "https://thetvdb.com/banners/" + record["fileName"]
+          hash[:type]           = record["keyType"]
+          hash[:subkey]         = record["subKey"]
+          hash[:resolution]     = record["resolution"]
+          hash[:rating_average] = record["ratingsInfo"]["average"] if record["ratingsInfo"]
+          hash[:rating_count]   = record["ratingsInfo"]["count"] if record["ratingsInfo"]
+          hash[:thumbnail_url]  = "https://thetvdb.com/banners/" + record["thumbnail"]
+
+          result = Image.new(hash)
+          results_array << result
+        end
+      rescue NoMethodError
+        # Means an empty result set was found, don't do anything special
+        # here as this method will return an empty array.
+      end
+      results_array
+    end
+
+  end
+end

data/lib/tvdbjson/request.rb

@@ -0,0 +1,26 @@
+module Tvdbjson
+  class Request
+    BASE_URI = "https://api.thetvdb.com"
+
+    attr_accessor :url, :body, :headers, :authentication
+
+    def initialize(options = {})
+      @url = "#{BASE_URI}#{options[:uri]}"
+      @body = options[:body]
+      @headers = {
+        'Accept-Language' => 'en',
+        'Content-Type' => 'application/json',
+        'User-Agent' => "Tvdbjson Ruby Gem v#{Tvdbjson::VERSION}"
+      }.merge(options[:header])
+    end
+
+    def get
+      HTTParty.get(@url, :headers => @headers, :body => @body.to_json)
+    end
+
+    def post
+      HTTParty.post(@url, :headers => @headers, :body => @body.to_json)
+    end
+
+  end
+end

data/lib/tvdbjson/requestable.rb

@@ -0,0 +1,35 @@
+module Tvdbjson
+  module Requestable
+
+    def send_authenticated_request(hash, authentication)
+      options = {}
+      options[:uri] = build_uri(hash[:uri],hash[:params])
+      options[:body] = hash[:body]
+      options[:header] = { "Accept-Language" => "en", "Authorization" => "Bearer #{authentication.token}" }
+
+      request = Request.new(options)
+
+      response = if hash[:method] == "GET"
+        request.get
+      elsif hash[:method] == "POST"
+        request.post
+      end
+
+      if hash[:after_action]
+        eval(hash[:after_action])
+      else
+        response
+      end
+
+    end
+
+    def build_uri(uri, params)
+      query_string = "?"
+      params.each do |key, value|
+        query_string = "#{query_string}#{key}=#{value}&"
+      end
+      URI.escape(uri+query_string)
+    end
+
+  end
+end

data/lib/tvdbjson/series.rb

@@ -0,0 +1,83 @@
+module Tvdbjson
+  class Series
+    include Tvdbjson::Hashable
+    extend Tvdbjson::Requestable
+    attr_accessor :id, :name, :overview, :network, :banner_url, :first_aired, :status, :aliases
+
+    def initialize(options = {})
+      @id          = options[:id]
+      @name        = options[:name]
+      @overview    = options[:overview]
+      @network     = options[:network]
+      @banner_url  = options[:banner_url]
+      @first_aired = options[:first_aired]
+      @status      = options[:status]
+      @aliases     = options[:aliases]
+    end
+
+    def self.search_by_name(str, authentication)
+      raise Tvdbjson::RequiredSearchParamMissingError if !str
+      raise Tvdbjson::AuthenticationObjectMissingError unless authentication.kind_of?(Tvdbjson::Authentication)
+
+      hash = {
+        :method       => "GET",
+        :uri          => "/search/series",
+        :after_action => "Tvdbjson::Series.from_response(response)",
+        :params       => { "name" => str }
+      }
+      send_authenticated_request(hash, authentication)
+    end
+
+    def self.search_by_imdb(str, authentication)
+      raise Tvdbjson::RequiredSearchParamMissingError if !str
+      raise Tvdbjson::AuthenticationObjectMissingError unless authentication.kind_of?(Tvdbjson::Authentication)
+
+      hash = {
+        :method       => "GET",
+        :uri          => "/search/series",
+        :after_action => "Tvdbjson::Series.from_response(response)",
+        :params       => { "imdbId" => str }
+      }
+      send_authenticated_request(hash, authentication)
+    end
+
+    def self.search_by_zap2it_id(str, authentication)
+      raise Tvdbjson::RequiredSearchParamMissingError if !str
+      raise Tvdbjson::AuthenticationObjectMissingError unless authentication.kind_of?(Tvdbjson::Authentication)
+
+      hash = {
+        :method       => "GET",
+        :uri          => "/search/series",
+        :after_action => "Tvdbjson::Series.from_response(response)",
+        :params       => { "zap2itId" => str }
+      }
+      send_authenticated_request(hash, authentication)
+    end
+
+    def self.from_response(response)
+      results_array = []
+
+      begin
+        response.parsed_response["data"].each do |record|
+          hash               = {}
+          hash[:id]          = record["id"]
+          hash[:name]        = record["seriesName"]
+          hash[:overview]    = record["overview"]
+          hash[:network]     = record["network"]
+          hash[:banner_url]  = "https://thetvdb.com/banners/" + record["banner"]
+          hash[:first_aired] = record["firstAired"]
+          hash[:status]      = record["status"]
+          hash[:aliases]     = record["aliases"]
+
+          result             = Series.new(hash)
+          results_array      << result
+        end
+      rescue NoMethodError
+        # Means an empty result set was found, don't do anything special
+        # here as this method will return an empty array.
+      end
+      results_array
+    end
+
+  end
+end

data/lib/tvdbjson/version.rb

@@ -0,0 +1,3 @@
+module Tvdbjson
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: tvdbjson
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jeremy Tennant
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-11-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+description: Unofficial Ruby Gem for thetvdb.com Swagger API (JSON API)
+email: tennantje@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.md
+- README.md
+- lib/tvdbjson.rb
+- lib/tvdbjson/authentication.rb
+- lib/tvdbjson/episode.rb
+- lib/tvdbjson/error.rb
+- lib/tvdbjson/hashable.rb
+- lib/tvdbjson/image.rb
+- lib/tvdbjson/request.rb
+- lib/tvdbjson/requestable.rb
+- lib/tvdbjson/series.rb
+- lib/tvdbjson/version.rb
+homepage: https://github.com/tennantje/tvdbjson
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Unofficial Ruby Gem for thetvdb.com Swagger API (JSON API)
+test_files: []