flix 0.0.1 → 0.0.2

data/flix.gemspec

@@ -2,11 +2,18 @@
 require File.expand_path('../lib/flix/version', __FILE__)
 
 Gem::Specification.new do |gem|
+  gem.add_dependency 'faraday', '~> 0.8'
+  gem.add_dependency 'faraday_middleware', '~> 0.8'
+  gem.add_dependency 'multi_json', '~> 1.3'
+  gem.add_dependency 'simple_oauth', '~> 0.1.6' #not sure if this is needed
+  
+  gem.add_development_dependency 'json'
+    
   gem.authors       = ["Andrew Gertig"]
   gem.email         = ["andrew@otherscreen.com"]
-  gem.description   = %q{API wrapper}
-  gem.summary       = %q{Walking through the process of creating an API client}
-  gem.homepage      = ""
+  gem.description   = %q{A Ruby wrapper for the API}
+  gem.summary       = %q{API client}
+  gem.homepage      = "https://github.com/AndrewGertig/flix"
 
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

data/lib/flix.rb

@@ -1,5 +1,33 @@
-require "flix/version"
+# require "flix/version"
+require 'flix/client'
+require 'flix/configurable'
 
 module Flix
-  # Your code goes here...
+  class << self
+    include Flix::Configurable
+
+    # Delegate to a Flix::Client
+    #
+    # @return [Flix::Client]
+    def client
+      if @client && @client.cache_key == options.hash
+        @client
+      else
+        @client = Flix::Client.new(options)
+      end
+    end
+
+    def respond_to_missing?(method_name, include_private=false); client.respond_to?(method_name, include_private); end if RUBY_VERSION >= "1.9"
+    def respond_to?(method_name, include_private=false); client.respond_to?(method_name, include_private) || super; end if RUBY_VERSION < "1.9"
+
+  private
+
+    def method_missing(method_name, *args, &block)
+      return super unless client.respond_to?(method_name)
+      client.send(method_name, *args, &block)
+    end
+
+  end
 end
+
+Flix.setup

data/lib/flix/api.rb

@@ -0,0 +1,58 @@
+# require 'twitter/user'
+
+module Twitter
+  module API
+    
+    # def user(*args)
+    #   options = args.extract_options!
+    #   if user = args.pop
+    #     options.merge_user!(user)
+    #     object_from_response(Twitter::User, :get, "/1/users/show.json", options)
+    #   end
+    # end
+    
+    def user(*args)
+      options = args.extract_options!
+      if netflix_uid = args.pop
+        client = shared_client(user)
+        url = "/users/#{netflix_uid}"
+        # puts "get this URL #{url}"
+        
+        response = from_response(:get, url, {output: "json"}, options)
+
+        # response = client.get do |req|
+        #   req.url url
+        #   req.params['output'] = "json"
+        # end
+
+        puts "&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&"
+        puts "RECEIVED FROM NETFLIX"
+        puts "-------------HEADERS-----------------"
+        puts "#{response.headers}"
+        puts "----------------BODY--------------"
+        puts "#{response.body}"
+        puts "----------------------------------"
+
+        return response.body
+      end
+    end
+    
+private
+   
+   # # @param klass [Class]
+   # # @param request_method [Symbol]
+   # # @param url [String]
+   # # @param params [Hash]
+   # # @param options [Hash]
+   # # @return [Object]
+   # def object_from_response(klass, request_method, url, params={}, options={})
+   #   response = send(request_method.to_sym, url, params, options)
+   #   klass.from_response(response)
+   # end
+   
+   def from_response(request_method, url, params={}, options={})
+     response = send(request_method.to_sym, url, params, options)
+   end
+
+  end
+end

data/lib/flix/client.rb

@@ -0,0 +1,103 @@
+require 'faraday'
+require 'faraday_middleware'
+require 'flix/configurable'
+
+require 'multi_json'
+require 'flix/api'
+# require 'twitter/error/client_error'
+# require 'twitter/error/decode_error'
+# require 'twitter/rate_limit'
+require 'simple_oauth'
+require 'uri'
+module Flix
+  
+  class Client
+    include Flix::API
+    include Flix::Configurable
+
+    # Initializes a new Client object
+    #
+    # @param options [Hash]
+    # @return [Flix::Client]
+    def initialize(options={})
+      Flix::Configurable.keys.each do |key|
+        instance_variable_set(:"@#{key}", options[key] || Flix.instance_variable_get(:"@#{key}"))
+      end
+    end
+
+    # Perform an HTTP DELETE request
+    def delete(path, params={}, options={})
+      request(:delete, path, params, options)
+    end
+
+    # Perform an HTTP GET request
+    def get(path, params={}, options={})
+      request(:get, path, params, options)
+    end
+
+    # Perform an HTTP POST request
+    def post(path, params={}, options={})
+      request(:post, path, params, options)
+    end
+
+    # Perform an HTTP UPDATE request
+    def put(path, params={}, options={})
+      request(:put, path, params, options)
+    end
+
+  private
+
+    # Returns a Faraday::Connection object
+    #
+    # @return [Faraday::Connection]
+    def connection
+      @connection ||= Faraday.new(@endpoint, @connection_options.merge(:builder => @middleware))
+    end
+
+    # Perform an HTTP request
+    #
+    # @raise [Flix::Error::ClientError, Flix::Error::DecodeError]
+    def request(method, path, params={}, options={})
+      uri = options[:endpoint] || @endpoint
+      uri = URI(uri) unless uri.respond_to?(:host)
+      uri += path
+      request_headers = {}
+      
+      if credentials?
+        authorization = auth_header(method, uri, params)
+        request_headers[:authorization] = authorization.to_s
+      end
+      
+      connection.url_prefix = options[:endpoint] || @endpoint
+      
+      response = connection.run_request(method.to_sym, path, nil, request_headers) do |request|
+        unless params.empty?
+          case request.method
+          when :post, :put
+            request.body = params
+          else
+            request.params.update(params)
+          end
+        end
+        yield request if block_given?
+      end.env
+      
+      # @rate_limit.update(response[:response_headers])
+      
+      response
+      
+    rescue Faraday::Error::ClientError
+      # raise Flix::Error::ClientError
+      raise "Faraday Oops".to_yaml
+    rescue MultiJson::DecodeError
+      # raise Flix::Error::DecodeError
+      raise "MultiJson Oops".to_yaml
+    end
+
+    def auth_header(method, uri, params={})
+      # When posting a file, don't sign any params
+      signature_params = [:post, :put].include?(method.to_sym) && params.values.any?{|value| value.is_a?(File) || (value.is_a?(Hash) && (value[:io].is_a?(IO) || value[:io].is_a?(StringIO)))} ? {} : params
+      SimpleOAuth::Header.new(method, uri, signature_params, credentials)
+    end
+  end
+end

data/lib/flix/configurable.rb

@@ -0,0 +1,69 @@
+require 'flix/default'
+
+module Flix
+  module Configurable
+    attr_writer :consumer_key, :consumer_secret, :oauth_token, :oauth_token_secret
+    attr_accessor :endpoint, :connection_options, :middleware,  :identity_map
+    # attr_accessor :media_endpoint, :search_endpoint,
+    class << self
+
+      def keys
+        @keys ||= [
+          :consumer_key,
+          :consumer_secret,
+          :oauth_token,
+          :oauth_token_secret,
+          :endpoint,
+          :connection_options,
+          :middleware,
+          :identity_map,
+          # :media_endpoint,
+          # :search_endpoint,
+        ]
+      end
+
+    end
+
+    # Convenience method to allow configuration options to be set in a block
+    def configure
+      yield self
+      self
+    end
+
+    # @return [Boolean]
+    def credentials?
+      credentials.values.all?
+    end
+
+    # @return [Fixnum]
+    def cache_key
+      options.hash
+    end
+
+    def reset!
+      Flix::Configurable.keys.each do |key|
+        instance_variable_set(:"@#{key}", Flix::Default.options[key])
+      end
+      self
+    end
+    alias setup reset!
+
+  private
+
+    # @return [Hash]
+    def credentials
+      {
+        :consumer_key => @consumer_key,
+        :consumer_secret => @consumer_secret,
+        :token => @oauth_token,
+        :token_secret => @oauth_token_secret,
+      }
+    end
+
+    # @return [Hash]
+    def options
+      Hash[Flix::Configurable.keys.map{|key| [key, instance_variable_get(:"@#{key}")]}]
+    end
+
+  end
+end

data/lib/flix/default.rb

@@ -0,0 +1,115 @@
+require 'faraday'
+require 'flix/configurable'
+# require 'flix/error/client_error'
+# require 'flix/error/server_error'
+require 'flix/identity_map'
+# require 'flix/request/multipart_with_file'
+# require 'flix/response/parse_json'
+# require 'flix/response/raise_error'
+require 'flix/version'
+
+module Flix
+  module Default
+    ENDPOINT = 'http://api.netflix.com' unless defined? ENDPOINT
+    # MEDIA_ENDPOINT = 'https://upload.flix.com' unless defined? MEDIA_ENDPOINT
+    # SEARCH_ENDPOINT = 'https://search.flix.com' unless defined? SEARCH_ENDPOINT
+    CONNECTION_OPTIONS = {
+      :headers => {
+        :accept => 'application/json',
+        :user_agent => "Flix Ruby Gem #{Flix::VERSION}"
+      },
+      :open_timeout => 5,
+      :raw => true,
+      :ssl => {:verify => false},
+      :timeout => 10,
+    } unless defined? CONNECTION_OPTIONS
+    IDENTITY_MAP = Flix::IdentityMap unless defined? IDENTITY_MAP
+    MIDDLEWARE = Faraday::Builder.new(
+      &Proc.new do |builder|
+        # # Convert file uploads to Faraday::UploadIO objects
+        # builder.use Flix::Request::MultipartWithFile
+        # # Checks for files in the payload
+        # builder.use Faraday::Request::Multipart
+        
+        builder.use Faraday::Request::OAuth, Flix::Default.options
+        # Convert request params to "www-form-urlencoded"
+        builder.use Faraday::Request::UrlEncoded
+        # Handle 4xx server responses
+        # builder.use Flix::Response::RaiseError, Flix::Error::ClientError
+        # # Parse JSON response bodies using MultiJson
+        # builder.use Flix::Response::ParseJson
+        # # Handle 5xx server responses
+        # builder.use Flix::Response::RaiseError, Flix::Error::ServerError
+        # Set Faraday's HTTP adapter
+        builder.adapter Faraday.default_adapter
+      end
+    )
+
+    class << self
+
+      # @return [Hash]
+      def options
+        Hash[Flix::Configurable.keys.map{|key| [key, send(key)]}]
+      end
+
+      # @return [String]
+      def consumer_key
+        ENV['NETFLIX_CONSUMER_KEY']
+      end
+
+      # @return [String]
+      def consumer_secret
+        ENV['NETFLIX_CONSUMER_SECRET']
+      end
+
+      # @return [String]
+      def oauth_token
+        ENV['NETFLIX_OAUTH_TOKEN']
+      end
+
+      # @return [String]
+      def oauth_token_secret
+        ENV['NETFLIX_OAUTH_TOKEN_SECRET']
+      end
+
+      # @note This is configurable in case you want to use HTTP instead of HTTPS or use a Netflix-compatible endpoint.
+      # @see http://status.net/wiki/Flix-compatible_API
+      # @see http://en.blog.wordpress.com/2009/12/12/flix-api/
+      # @see http://staff.tumblr.com/post/287703110/api
+      # @see http://developer.typepad.com/typepad-flix-api/flix-api.html
+      # @return [String]
+      def endpoint
+        ENDPOINT
+      end
+
+      # # @return [String]
+      # def media_endpoint
+      #   MEDIA_ENDPOINT
+      # end
+      # 
+      # # @return [String]
+      # def search_endpoint
+      #   SEARCH_ENDPOINT
+      # end
+
+      # @return [Hash]
+      def connection_options
+        CONNECTION_OPTIONS
+      end
+
+      # @return [Flix::IdentityMap]
+      def identity_map
+        IDENTITY_MAP
+      end
+
+      # @note Faraday's middleware stack implementation is comparable to that of Rack middleware.  The order of middleware is important: the first middleware on the list wraps all others, while the last middleware is the innermost one.
+      # @see https://github.com/technoweenie/faraday#advanced-middleware-usage
+      # @see http://mislav.uniqpath.com/2011/07/faraday-advanced-http/
+      # @return [Faraday::Builder]
+      def middleware
+        MIDDLEWARE
+      end
+
+    end
+  end
+end

data/lib/flix/identity_map.rb

@@ -0,0 +1,22 @@
+module Flix
+
+  # Tracks objects to help ensure that each object gets loaded only once.
+  # See: http://www.martinfowler.com/eaaCatalog/identityMap.html
+  class IdentityMap < Hash
+
+    # @param id
+    # @return [Object]
+    def fetch(id)
+      self[id]
+    end
+
+    # @param id
+    # @param object
+    # @return [Object]
+    def store(id, object)
+      self[id] = object
+    end
+
+  end
+
+end

data/lib/flix/user.rb

@@ -0,0 +1,9 @@
+require 'flix/basic_user'
+require 'flix/creatable'
+
+module Flix
+  class User < Flix::BasicUser
+    include Flix::Creatable
+
+  end
+end

data/lib/flix/version.rb

@@ -1,3 +1,3 @@
 module Flix
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flix
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -10,8 +10,88 @@ autorequire:
 bindir: bin
 cert_chain: []
 date: 2012-08-24 00:00:00.000000000 Z
-dependencies: []
-description: API wrapper
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: simple_oauth
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.6
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Ruby wrapper for the API
 email:
 - andrew@otherscreen.com
 executables: []
@@ -25,8 +105,14 @@ files:
 - Rakefile
 - flix.gemspec
 - lib/flix.rb
+- lib/flix/api.rb
+- lib/flix/client.rb
+- lib/flix/configurable.rb
+- lib/flix/default.rb
+- lib/flix/identity_map.rb
+- lib/flix/user.rb
 - lib/flix/version.rb
-homepage: ''
+homepage: https://github.com/AndrewGertig/flix
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -49,5 +135,5 @@ rubyforge_project:
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Walking through the process of creating an API client
+summary: API client
 test_files: []