tmsapi 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9b01ee59db3a47937a63cea09c17aac262612367
+  data.tar.gz: c1d6f43454a2b9cd2c0dbaef16a35c2412d2d457
+SHA512:
+  metadata.gz: 25e7a6b9514b70c41326871cd990c11218543615d6ee340f18c99ab811b697e6ac637b0e176ae214784c54ba08247f93c57af7a4ad304900a6ad431b89da16a7
+  data.tar.gz: e1b45b87d6c51b2b2263dcea420590a4ef64d310efa4f4b859840103d2481fe966247c9c8e3e5228511aff79241c2526779f810a299e0135cfb9acc7ed746de4

data/.gitignore

@@ -0,0 +1,86 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.rbenv-vars
+.coveralls.yml
+.ruby-version
+.ruby-gemset
+
+# Compiled source #
+###################
+*.com
+*.class
+*.dll
+*.exe
+*.o
+*.so
+
+# Packages #
+############
+# it's better to unpack these files and commit the raw source
+# git has its own built in compression methods
+*.7z
+*.dmg
+*.gz
+*.iso
+*.jar
+*.rar
+*.tar
+*.zip
+
+# Logs and databases #
+######################
+*.log
+*.sql
+*.sqlite
+
+# OS generated files #
+######################
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db

data/.project

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+	<name>tmsapi</name>
+	<comment></comment>
+	<projects>
+	</projects>
+	<buildSpec>
+		<buildCommand>
+			<name>com.aptana.ide.core.unifiedBuilder</name>
+			<arguments>
+			</arguments>
+		</buildCommand>
+	</buildSpec>
+	<natures>
+		<nature>com.aptana.ruby.core.rubynature</nature>
+	</natures>
+</projectDescription>

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.3
+  - 2.0.0
+  - ruby-head
+script: bundle exec rake
+matrix:
+  allow_failures:
+    - rvm: 1.8.7
+    - rvm: ruby-head

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,94 @@
+PATH
+  remote: .
+  specs:
+    tmsapi (0.0.1)
+      faraday (~> 0.8.7)
+      faraday_middleware (~> 0.9.0)
+      json (~> 1.8.1)
+      rash (~> 0.4.0)
+      virtus (~> 1.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.0.2)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    atomic (1.1.14)
+    axiom-types (0.0.5)
+      descendants_tracker (~> 0.0.1)
+      ice_nine (~> 0.9)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
+    coveralls (0.7.0)
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      term-ansicolor
+      thor
+    descendants_tracker (0.0.3)
+    diff-lcs (1.2.5)
+    docile (1.1.1)
+    equalizer (0.0.8)
+    factory_girl (4.3.0)
+      activesupport (>= 3.0.0)
+    fakeweb (1.3.0)
+    faraday (0.8.8)
+      multipart-post (~> 1.2.0)
+    faraday_middleware (0.9.0)
+      faraday (>= 0.7.4, < 0.9)
+    hashie (2.0.5)
+    i18n (0.6.9)
+    ice_nine (0.11.0)
+    json (1.8.1)
+    mime-types (2.0)
+    minitest (4.3.2)
+    multi_json (1.8.2)
+    multipart-post (1.2.0)
+    rake (10.1.0)
+    rash (0.4.0)
+      hashie (~> 2.0.0)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.4)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.4)
+    simplecov (0.8.2)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    term-ansicolor (1.2.2)
+      tins (~> 0.8)
+    thor (0.18.1)
+    thread_safe (0.1.3)
+      atomic
+    tins (0.13.1)
+    tzinfo (0.3.38)
+    vcr (2.8.0)
+    virtus (1.0.1)
+      axiom-types (~> 0.0.5)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0.1)
+      equalizer (~> 0.0.7)
+
+PLATFORMS
+  ruby
+  x86-mingw32
+
+DEPENDENCIES
+  coveralls (~> 0.7.0)
+  factory_girl (~> 4.0)
+  fakeweb (~> 1.3.0)
+  rake (~> 10.1.0)
+  rspec (~> 2.0)
+  tmsapi!
+  vcr (~> 2.4)

data/Rakefile

@@ -0,0 +1,14 @@
+#encoding: utf-8
+require 'rubygems'
+require 'bundler'
+Bundler.setup
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+desc 'Run RSpec'
+RSpec::Core::RakeTask.new do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rspec_opts = ['--color', '--format nested']
+end
+
+task :default => :spec

data/Readme.md

@@ -0,0 +1,62 @@
+# TMS API
+
+[![Build Status](https://travis-ci.org/JDiPierro/tmsapi.png?branch=master)](https://travis-ci.org/JDiPierro/tmsapi)
+[![Coverage Status](https://coveralls.io/repos/JDiPierro/tmsapi/badge.png?branch=master)](https://coveralls.io/r/JDiPierro/tmsapi?branch=master)
+[![Dependency Status](https://gemnasium.com/JDiPierro/tmsapi.png)](https://gemnasium.com/JDiPierro/tmsapi)
+
+A Ruby wrapper around connecting to the [TMS API](https://developer.tmsapi.com)
+
+This is my first project in Ruby so I'm using [petems/riot_api](https://github.com/petems/riot_api/) as a template.
+
+## Installation
+
+Not yet published to Rubygems
+
+## Usage:
+
+You'll need to get an API key from [http://developer.tmsapi.com/](http://developer.tmsapi.com/).
+
+The free Public key has access to the following methods:
+
+movies.theatres.showings
+
+movies.tv.airings
+
+programs.new_shows
+
+sports.event_airings (Not Yet Implemented)
+
+
+```ruby
+require 'tmsapi'
+
+# Create Instace of the API
+client = TMSAPI::API.new :api_key => 'API_KEY_HERE', :debug => true
+
+```
+
+## 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
+
+## Testing
+
+```shell
+bundle install
+```
+
+If adding new test:
+
+```shell
+RECORDING=1 TMS_API_KEY=your-api-key rspec
+```
+
+If running existing tests:
+
+```shell
+rspec
+```

data/lib/tmsapi/api.rb

@@ -0,0 +1,61 @@
+require File.expand_path('../middleware/custom_logger', __FILE__)
+
+module TMSAPI
+  class API
+
+    # Creates a new TMS API client instance.
+    #
+    # @param [Hash] params
+    # @option params [String] :api_key The api_key (required)
+    #
+    # @see [Faraday]
+    def initialize(params)
+      @api_key             = params[:api_key]
+      @debug               = params[:debug]
+      @ssl                 = params[:ssl] || { :verify => true }
+      @base_url            = params[:base_url]            || "http://data.tmsapi.com/"
+      @faraday_adapter     = params[:faraday_adapter]     || Faraday.default_adapter
+      @raise_status_errors = params[:raise_status_errors] || true
+      @faraday             = params[:faraday]             || default_faraday
+      raise ArgumentError, ':api_key missing' unless @api_key
+    end
+
+    def programs
+      TMSAPI::Resource::Programs.new(@faraday)
+    end
+    
+    def stations
+      TMSAPI::Resource::Stations.new(@faraday)
+    end
+    
+    def lineups
+      TMSAPI::Resource::Lineups.new(@faraday)
+    end
+    
+    def series
+      TMSAPI::Resource::Series.new(@faraday)
+    end
+    
+    def movies
+      TMSAPI::Resource::Movies.new(@faraday)
+    end
+    
+    def sports
+      TMSAPI::Resource::Sports.new(@faraday)
+    end
+
+    def default_faraday
+      Faraday.new(:url => @base_url, :ssl => @ssl) do |faraday|
+        faraday.use CustomLogger if @debug
+        faraday.request  :url_encoded
+        faraday.response :rashify
+        faraday.response :json
+        faraday.use Faraday::Response::RaiseError if @raise_status_errors
+        faraday.adapter @faraday_adapter
+        faraday.params['api_key'] = @api_key
+        faraday.headers['User-Agent'] = "tmsapi rubygem v#{TMSAPI::VERSION}"
+      end
+    end
+
+  end
+end

data/lib/tmsapi/middleware/custom_logger.rb

@@ -0,0 +1,70 @@
+module TMSAPI
+  class CustomLogger < Faraday::Middleware
+      extend Forwardable
+      def_delegators :@logger, :debug, :info, :warn, :error, :fatal
+
+      def initialize(app, options = {})
+        @app = app
+        @logger = options.fetch(:logger) {
+          require 'logger'
+          ::Logger.new($stdout)
+        }
+      end
+
+      def call(env)
+        start_time = Time.now
+        info  { request_info(env) }
+        debug { request_debug(env) }
+        @app.call(env).on_complete do
+          end_time = Time.now
+          response_time = end_time - start_time
+          info  { response_info(env, response_time) }
+          debug { response_debug(env) }
+        end
+      end
+
+      private
+
+      def filter(output)
+        unless ENV['DEBUG'] == '2'
+          output = output.to_s.gsub(/api_key=[a-zA-Z0-9-]*/,'api_key=[API-KEY]')
+        else
+          output
+        end
+      end
+
+      def request_info(env)
+        "Started %s request to: %s" % [ env[:method].to_s.upcase, filter(env[:url]) ]
+      end
+
+      def response_info(env, response_time)
+        "Response from %s; Status: %d; Time: %.1fms" % [ filter(env[:url]), env[:status], (response_time * 1_000.0) ]
+      end
+
+      def request_debug(env)
+        debug_message("Request", env[:request_headers], env[:body])
+      end
+
+      def response_debug(env)
+        debug_message("Response", env[:response_headers], env[:body])
+      end
+
+      def debug_message(name, headers, body)
+        <<-MESSAGE.gsub(/^ +([^ ])/m, '\\1')
+        #{name} Headers:
+        ----------------
+        #{format_headers(headers)}
+
+        #{name} Body:
+        -------------
+        #{body}
+        MESSAGE
+      end
+
+      def format_headers(headers)
+        length = headers.map {|k,v| k.to_s.size }.max
+        headers.map { |name, value| "#{name.to_s.ljust(length)} : #{filter(value)}" }.join("\n")
+      end
+
+  end
+end

data/lib/tmsapi/model/airing.rb

@@ -0,0 +1,24 @@
+require 'tmsapi/model/program'
+require 'tmsapi/model/station'
+require 'tmsapi/model/rating'
+require 'tmsapi/model/quality_rating'
+
+module TMSAPI
+  module Model
+    class Airing < Base
+      attribute :start_time, String
+      attribute :endTime, String
+      attribute :duration, Integer
+      attribute :ratings, Array[TMSAPI::Model::Rating]
+      attribute :qualifiers, Array[String]
+      attribute :channels, Array[String]
+      attribute :station, TMSAPI::Model::Station 
+      attribute :station_id, Integer
+      attribute :program, TMSAPI::Model::Program
+      attribute :release_year, Integer
+      attribute :quality_rating, TMSAPI::Model::QualityRating
+      attribute :entity_type, String
+    
+    end
+  end
+end

data/lib/tmsapi/model/award.rb

@@ -0,0 +1,14 @@
+module TMSAPI
+  module Model
+    class Award < Base
+      attribute :award_id, Integer
+      attribute :award_name, String
+      attribute :category, String
+      attribute :award_cat_id, Integer
+      attribute :year, Integer
+      attribute :recipient, String
+      attribute :person_id, Integer
+      
+    end
+  end
+end

data/lib/tmsapi/model/base.rb

@@ -0,0 +1,9 @@
+require 'virtus'
+
+module TMSAPI
+  module Model
+    class Base
+      include Virtus.model
+    end
+  end
+end

data/lib/tmsapi/model/caption.rb

@@ -0,0 +1,8 @@
+module TMSAPI
+  module Model
+    class Caption < Base
+      attribute :content, String
+      attribute :lang, String
+    end
+  end
+end

data/lib/tmsapi/model/episode.rb

@@ -0,0 +1,11 @@
+require 'tmsapi/model/program'
+
+module TMSAPI
+  module Model
+    class Episode < Program
+      attribute :episode_title, String
+      attribute :season_num, Integer
+      attribute :episode_num, Integer
+    end
+  end
+end

data/lib/tmsapi/model/event.rb

@@ -0,0 +1,10 @@
+module TMSAPI
+  module Model
+    class Event < Base
+      attribute :air_date, String
+      attribute :event_code, String
+      attribute :last_update, String
+      attribute :program, TMSAPI::Model::Program
+    end
+  end
+end

data/lib/tmsapi/model/image.rb

@@ -0,0 +1,16 @@
+require 'tmsapi/model/caption'
+
+module TMSAPI
+  module Model
+    class Image < Base
+      attribute :uri, String
+      attribute :height, Integer
+      attribute :width, Integer
+      attribute :primary, String
+      attribute :category, String
+      attribute :tier, String
+      attribute :caption, TMSAPI::Model::Caption
+      
+    end
+  end
+end

data/lib/tmsapi/model/lineup.rb

@@ -0,0 +1,12 @@
+module TMSAPI
+  module Model
+    class Lineup < Base
+      attribute :type, String
+      attribute :lineup_id, String
+      attribute :name, String
+      attribute :device, String
+      attribute :location, String
+      
+    end
+  end
+end

data/lib/tmsapi/model/movie.rb

@@ -0,0 +1,16 @@
+require 'tmsapi/model/program'
+require 'tmsapi/model/showtime'
+
+module TMSAPI
+  module Model
+    class Movie < Program
+      attribute :release_year, Integer
+      attribute :quality_rating, TMSAPI::Model::QualityRating
+      attribute :sub_type, String
+      attribute :directors, Array[String]
+      attribute :advisories, Array[String]
+      attribute :run_time, String
+      attribute :showtimes, Array[TMSAPI::Model::Showtime]
+    end
+  end
+end

data/lib/tmsapi/model/person.rb

@@ -0,0 +1,12 @@
+module TMSAPI
+  module Model
+    class Person < Base
+      attribute :person_id, Integer
+      attribute :name_id, Integer
+      attribute :name, String
+      attribute :role, String
+      attribute :character_name, String
+      attribute :billing_order, Integer
+    end
+  end
+end

data/lib/tmsapi/model/program.rb

@@ -0,0 +1,36 @@
+require "tmsapi/model/award"
+require "tmsapi/model/image"
+require "tmsapi/model/person"
+require "tmsapi/model/rating"
+require "tmsapi/model/recommendation"
+
+module TMSAPI
+  module Model
+    class Program < Base
+      attribute :tms_id, String
+      attribute :root_id, Integer
+      attribute :series_id, Integer
+      attribute :active, Boolean
+      attribute :title, String
+      attribute :title_lang, String
+      attribute :short_description, String
+      attribute :long_description, String
+      attribute :description_lang, String
+      attribute :ratings, Array[TMSAPI::Model::Rating]
+      attribute :genres, Array[String]
+      attribute :recommendations, Array[TMSAPI::Model::Recommendation]
+      attribute :top_cast, Array[String]
+      attribute :orig_air_date, String
+      attribute :preferred_image, TMSAPI::Model::Image
+      attribute :sub_type, String
+      attribute :awards, Array[TMSAPI::Model::Award]
+      attribute :cast, Array[TMSAPI::Model::Person]
+      attribute :crew, Array[TMSAPI::Model::Person]
+      #attribute :keywords, WUDUFUQ
+      attribute :total_seasons, Integer
+      attribute :total_episodes, Integer
+      attribute :entity_type, String
+      
+    end
+  end
+end

data/lib/tmsapi/model/quality_rating.rb

@@ -0,0 +1,8 @@
+module TMSAPI
+  module Model
+    class QualityRating < Base
+      attribute :ratings_body, String
+      attribute :value, String
+    end
+  end
+end

data/lib/tmsapi/model/rating.rb

@@ -0,0 +1,8 @@
+module TMSAPI
+  module Model
+    class Rating < Base
+      attribute :body, String
+      attribute :code, String
+    end
+  end
+end

data/lib/tmsapi/model/recommendation.rb

@@ -0,0 +1,9 @@
+module TMSAPI
+  module Model
+    class Recommendation < Base
+      attribute :tms_id, String
+      attribute :root_id, Integer
+      attribute :title, String
+    end
+  end
+end

data/lib/tmsapi/model/showtime.rb

@@ -0,0 +1,13 @@
+require 'tmsapi/model/theatre'
+
+module TMSAPI
+  module Model
+    class Showtime < Base
+      attribute :theatre, TMSAPI::Model::Theatre
+      attribute :barg, Boolean
+      attribute :date_time, String
+      attribute :ticket_uri, String
+      attribute :quals, String
+    end
+  end
+end

data/lib/tmsapi/model/sport_event.rb

@@ -0,0 +1,11 @@
+require 'tmsapi/model/team'
+
+module TMSAPI
+  module Model
+    class SportEvent < Program
+      attribute :event_title, String
+      attribute :game_date, String
+      attribute :teams, Array[TMSAPI::Model::Team]
+    end
+  end
+end