traktion 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 13b7036911202e70d9af34cb1476ffad5c706f0b
+  data.tar.gz: c1c317b759e1a1fb21c2dd67ee7013c2ddc36e0c
+SHA512:
+  metadata.gz: 1acbdbf93c611caa40def2a4e2c9037a58e2079830c708b1fedeeeb86d8b51575e75bb142adcbb8eca589e5de68650036d675859455d91a38c7ad07056bd987a
+  data.tar.gz: 10db52a9939eb9b568e3fbaab7ab5996cb967da2e1b43cc62b1cbbbb69edcc7c38ae0578702d7daff537173a9f3ed177da797ce2e315c197920c2e2802b524e9

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.1
+before_install: gem install bundler -v 1.10.5

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Alan Ly
+
+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,53 @@
+# Traktion
+
+Traktion is an API client for Trakt.tv's V2 API. Based on the [Her ORM](https://github.com/remiprev/her) library, Traktion allows you to interface with the Trakt.tv API as if it's endpoints are Rails models. This means that it's extremely easy and intuitive to build applications that make use of Trakt.tv's vast dataset.
+
+This API client is targetted at server side applications that will build upon the Trakt data, such as querying metadata for a personal video library. It is not intended for applications that require client-side authentication (i.e. OAuth) in order to interface with an end-user's Trakt.tv account.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'traktion'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install traktion
+
+## Usage
+
+Obtain a **Client ID** from Trakt.tv by [applying for API access](https://trakt.tv/oauth/applications). Once you have registered an API application on Trakt.tv, you will find the ID/key in the respective application's _Details_ page.
+
+After having installed Traktion, you can use it by first obtaining the client instance (called Traktion Control, huehuehue) by calling the `.start` method with the client ID you've obtained:
+
+```ruby
+client = Traktion.start('<client ID>')
+```
+
+Once you have the client instance, you may now perform queries against the Trakt.tv API. For example, to get the summary for a TV show, you'd call the `find` method with the appropriate slug value on the `shows` resource.
+
+```ruby
+client.shows.find('community')
+#<Traktion::Models::Show(shows) title="Community" year=2009 ids={"trakt"=>18265, "slug"=>"community", "tvdb"=>94571, "imdb"=>"tt1439629", "tmdb"=>18347, "tvrage"=>22589}>
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+The client is currently incomplete, with a lot of the Trakt API endpoints currently being unimplemented. If you need access to a specific endpoint and/or are interested in contributing, bug reports and pull requests are always welcomed on GitHub at https://github.com/alanly/traktion.
+
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "traktion"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/traktion/control.rb

@@ -0,0 +1,7 @@
+module Traktion
+  class Control
+  end
+
+  require 'traktion/models/base'
+  require 'traktion/models/show'
+end

data/lib/traktion/middleware/api_key_authenticator.rb

@@ -0,0 +1,19 @@
+module Traktion
+  module Middleware
+    class ApiKeyAuthenticator < Faraday::Middleware
+      def initialize(app, options={})
+        @app = app
+        @options = options
+      end
+
+      def call(env)
+        env[:request_headers].merge!({
+          'Content-type'      => 'application/json',
+          'trakt-api-key'     => @options[:api_key],
+          'trakt-api-version' => '2',
+        })
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/traktion/models/base.rb

@@ -0,0 +1,8 @@
+module Traktion
+  module Models
+    class Base
+      include Her::Model
+      uses_api Traktion.api
+    end
+  end
+end

data/lib/traktion/models/show.rb

@@ -0,0 +1,34 @@
+module Traktion
+  class Control
+    def shows
+      @shows ||= Traktion::Models::Show
+    end
+  end
+
+  module Models
+    class Show < Base
+      custom_get :popular, :trending
+
+      def self.updates(date)
+        get("shows/updates/#{date}")
+      end
+
+      # Create accessor methods for the nested resources.
+      ['aliases', 'comments', 'people', 'ratings', 'translations'].each do |path|
+        define_method(path.to_s) do |argument = ''|
+          raw_resource(path.to_s, argument)
+        end
+      end
+
+      private
+
+      def slug
+        self.ids['slug']
+      end
+
+      def raw_resource(name, parameter = '')
+        Show.get_raw("shows/#{slug}/#{name}/#{parameter}") {|parsed_response| parsed_response[:data]}
+      end
+    end
+  end
+end

data/lib/traktion/version.rb

@@ -0,0 +1,3 @@
+module Traktion
+  VERSION = "0.1.0"
+end

data/lib/traktion.rb

@@ -0,0 +1,31 @@
+require "her"
+
+require "traktion/version"
+require "traktion/middleware/api_key_authenticator"
+
+module Traktion
+  ENDPOINT = "http://api-v2launch.trakt.tv/"
+
+  def self.api
+    @api
+  end
+
+  def self.start(api_key)
+    @api = Her::API.new
+    @api.setup(url: Traktion::ENDPOINT) do |c|
+      # Request Middleware
+      c.use Traktion::Middleware::ApiKeyAuthenticator, :api_key => api_key
+      c.use Faraday::Request::UrlEncoded
+
+      # Response Middleware
+      c.use Her::Middleware::DefaultParseJSON
+
+      # Adapter
+      c.use Faraday::Adapter::NetHttp
+    end
+
+    # Create the client instance.
+    require 'traktion/control'
+    Traktion::Control.new
+  end
+end

data/traktion.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'traktion/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "traktion"
+  spec.version       = Traktion::VERSION
+  spec.authors       = ["Alan Ly"]
+  spec.email         = ["hello@alan.ly"]
+
+  spec.summary       = %q{An ORM-styled client for server-side applications that use the Trakt.tv API v2.}
+  spec.description   = %q{This is an API client built on-top of Her, which allows for ActiveRecord-like
+    interactions with the Trakt.tv API. It is intended to be used in server-side applications that do not
+    require client-side authentication (i.e. OAuth).}
+  spec.homepage      = "https://github.com/alanly/traktion"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "her", "~> 0.7"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.3"
+  spec.add_development_dependency "pry", "~> 0.10"
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: traktion
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alan Ly
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-07-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: her
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description: |-
+  This is an API client built on-top of Her, which allows for ActiveRecord-like
+      interactions with the Trakt.tv API. It is intended to be used in server-side applications that do not
+      require client-side authentication (i.e. OAuth).
+email:
+- hello@alan.ly
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/traktion.rb
+- lib/traktion/control.rb
+- lib/traktion/middleware/api_key_authenticator.rb
+- lib/traktion/models/base.rb
+- lib/traktion/models/show.rb
+- lib/traktion/version.rb
+- traktion.gemspec
+homepage: https://github.com/alanly/traktion
+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.4.6
+signing_key: 
+specification_version: 4
+summary: An ORM-styled client for server-side applications that use the Trakt.tv API
+  v2.
+test_files: []