douban_api 0.1.0

data/lib/douban_api/configuration.rb

@@ -0,0 +1,92 @@
+require 'faraday'
+require File.expand_path('../../faraday/parts/filepart', __FILE__)
+require File.expand_path('../version', __FILE__)
+
+module Douban
+  # Defines constants and methods related to configuration
+  module Configuration
+    # An array of valid keys in the options hash when configuring a {Douban::API}
+    VALID_OPTIONS_KEYS = [
+      :adapter,
+      :client_id,
+      :client_secret,
+      :access_token,
+      :endpoint,
+      :format,
+      :user_agent,
+      :proxy,
+      :user_id
+    ].freeze
+
+    # An array of valid request/response formats
+    #
+    # @note Not all methods support the XML format.
+    VALID_FORMATS = [
+      :json].freeze
+
+    # The adapter that will be used to connect if none is set
+    #
+    # @note The default faraday adapter is Net::HTTP.
+    DEFAULT_ADAPTER = Faraday.default_adapter
+
+    # By default, don't set an application ID
+    DEFAULT_CLIENT_ID = nil
+
+    # By default, don't set an application secret
+    DEFAULT_CLIENT_SECRET = nil
+
+    # By default, don't set an application redirect uri
+    DEFAULT_REDIRECT_URI = nil
+
+    # By default, don't set a user access token
+    DEFAULT_ACCESS_TOKEN = nil
+
+    # The endpoint that will be used to connect if none is set
+    #
+    # @note There is no reason to use any other endpoint at this time
+    DEFAULT_ENDPOINT = 'https://api.douban.com/'.freeze
+
+    # The response format appended to the path and sent in the 'Accept' header if none is set
+    #
+    # @note JSON is the only available format at this time
+    DEFAULT_FORMAT = :json
+
+    # By default, don't use a proxy server
+    DEFAULT_PROXY = nil
+
+    # The user agent that will be sent to the API endpoint if none is set
+    DEFAULT_USER_AGENT = "Douban Ruby Gem #{Douban::VERSION}".freeze
+
+    # @private
+    attr_accessor *VALID_OPTIONS_KEYS
+
+    # When this module is extended, set all configuration options to their default values
+    def self.extended(base)
+      base.reset
+    end
+
+    # Convenience method to allow configuration options to be set in a block
+    def configure
+      yield self
+    end
+
+    # Create a hash of options and their values
+    def options
+      VALID_OPTIONS_KEYS.inject({}) do |option, key|
+        option.merge!(key => send(key))
+      end
+    end
+
+    # Reset all configuration options to defaults
+    def reset
+      self.adapter        = DEFAULT_ADAPTER
+      self.client_id      = DEFAULT_CLIENT_ID
+      self.client_secret  = DEFAULT_CLIENT_SECRET
+      self.access_token   = DEFAULT_ACCESS_TOKEN
+      self.endpoint       = DEFAULT_ENDPOINT
+      self.format         = DEFAULT_FORMAT
+      self.user_agent     = DEFAULT_USER_AGENT
+      self.proxy          = DEFAULT_PROXY
+    end
+  end
+end

data/lib/douban_api/connection.rb

@@ -0,0 +1,33 @@
+require 'faraday_middleware'
+Dir[File.expand_path('../../faraday/*.rb', __FILE__)].each{|f| require f}
+
+module Douban
+  # @private
+  module Connection
+    private
+
+    def connection(raw=false)
+      options = {
+        :headers => {'Accept' => "application/#{format}; charset=utf-8", 'User-Agent' => user_agent},
+        :proxy => proxy,
+        :ssl => {:verify => false},
+        :url => endpoint,
+      }
+
+      Faraday::Connection.new(options) do |connection|
+        connection.use FaradayMiddleware::OAuth2, client_id, access_token
+        connection.use FaradayMiddleware::Mashify unless raw
+        connection.use Faraday::Request::Multipart
+        connection.use Faraday::Request::UrlEncoded
+        connection.use FaradayMiddleware::Mashify unless raw
+        unless raw
+          case format.to_s.downcase
+          when 'json' then connection.use Faraday::Response::ParseJson
+          end
+        end
+        connection.use FaradayMiddleware::RaiseHttpException
+        connection.adapter(adapter)
+      end
+    end
+  end
+end

data/lib/douban_api/error.rb

@@ -0,0 +1,19 @@
+module Douban
+  # Custom error class for rescuing from all Douban errors
+  class Error < StandardError; end
+
+  # Raised when Douban returns the HTTP status code 400
+  class BadRequest < Error; end
+
+  # Raised when Douban returns the HTTP status code 404
+  class NotFound < Error; end
+
+  # Raised when Douban returns the HTTP status code 500
+  class InternalServerError < Error; end
+
+  # Raised when Douban returns the HTTP status code 503
+  class ServiceUnavailable < Error; end
+
+  # Raised when a subscription payload hash is invalid
+  class InvalidSignature < Error; end
+end

data/lib/douban_api/oauth.rb

@@ -0,0 +1,27 @@
+module Douban
+  # Defines HTTP request methods
+  module OAuth
+    # Return URL for OAuth authorization
+    def authorize_url(options={})
+      options[:response_type] ||= "code"
+      params = access_token_params.merge(options)
+      connection.build_url("https://www.douban.com/service/auth2/auth", params).to_s
+    end
+
+    # Return an access token from authorization
+    def get_access_token(code, options={})
+      options[:grant_type] ||= "authorization_code"
+      params = access_token_params.merge(options)
+      post("https://www.douban.com/service/auth2/token", params.merge(:code => code), raw=false)
+    end
+
+    private
+
+    def access_token_params
+      {
+        :client_id => client_id,
+        :client_secret => client_secret
+      }
+    end
+  end
+end

data/lib/douban_api/request.rb

@@ -0,0 +1,40 @@
+module Douban
+  # Defines HTTP request methods
+  module Request
+    # Perform an HTTP GET request
+    def get(path, options={}, raw=false)
+      request(:get, path, options, raw)
+    end
+
+    # Perform an HTTP POST request
+    def post(path, options={}, raw=false)
+      request(:post, path, options, raw)
+    end
+
+    # Perform an HTTP PUT request
+    def put(path, options={}, raw=false)
+      request(:put, path, options, raw)
+    end
+
+    # Perform an HTTP DELETE request
+    def delete(path, options={}, raw=false)
+      request(:delete, path, options, raw)
+    end
+
+    private
+
+    # Perform an HTTP request
+    def request(method, path, options={}, raw=false)
+      response = connection(raw).send(method) do |request|
+        case method
+        when :get, :delete
+          request.url(path, options)
+        when :post, :put
+          request.path = path
+          request.body = options unless options.empty?
+        end
+      end
+      raw ? response : response.body
+    end
+  end
+end

data/lib/douban_api/version.rb

@@ -0,0 +1,3 @@
+module Douban
+  VERSION = '0.1.0'.freeze unless defined?(::Douban::VERSION)
+end

data/lib/douban_api.rb

@@ -0,0 +1,27 @@
+require File.expand_path('../douban_api/error', __FILE__)
+require File.expand_path('../douban_api/configuration', __FILE__)
+require File.expand_path('../douban_api/api', __FILE__)
+require File.expand_path('../douban_api/client', __FILE__)
+
+module Douban
+  extend Configuration
+
+  # Alias for Douban::Client.new
+  #
+  # @return [Douban::Client]
+  def self.client(options={})
+    Douban::Client.new(options)
+  end
+
+  # Delegate to Douban::Client
+  def self.method_missing(method, *args, &block)
+    return super unless client.respond_to?(method)
+    client.send(method, *args, &block)
+  end
+
+  # Delegate to Douban::Client
+  def self.respond_to?(method)
+    return client.respond_to?(method) || super
+  end
+  
+end

data/lib/faraday/oauth2.rb

@@ -0,0 +1,39 @@
+require 'faraday'
+
+# @private
+module FaradayMiddleware
+  # @private
+  class OAuth2 < Faraday::Middleware
+    def call(env)
+      if env[:method] == :get or env[:method] == :delete
+        if env[:url].query.nil?
+          query = {}
+        else
+          query = Faraday::Utils.parse_query(env[:url].query)
+        end
+        if @access_token and not query["client_secret"]
+          # env[:url].query = Faraday::Utils.build_query(query.merge(:access_token => @access_token))
+          env[:request_headers] = env[:request_headers].merge('Authorization' => "Bearer #{@access_token}")
+        elsif @client_id
+          env[:url].query = Faraday::Utils.build_query(query.merge(:appkey => @client_id))
+        end
+      else
+        if @access_token and not env[:body] && env[:body][:client_secret]
+          env[:body] = {} if env[:body].nil?
+          # env[:body] = env[:body].merge(:access_token => @access_token)
+          env[:request_headers] = env[:request_headers].merge('Authorization' => "Bearer #{@access_token}")
+        elsif @client_id
+          env[:body] = env[:body].merge(:client_id => @client_id)
+        end
+      end
+
+      @app.call env
+    end
+
+    def initialize(app, client_id, access_token=nil)
+      @app = app
+      @client_id = client_id
+      @access_token = access_token
+    end
+  end
+end

data/lib/faraday/parts/filepart.rb

@@ -0,0 +1,10 @@
+# monkey patch from @liluo https://gist.github.com/4176272
+class Faraday::Parts::FilePart
+  def initialize(boundary, name, io) 
+    file_length = io.respond_to?(:length) ?  io.length : File.size(io.local_path)    
+    @head = build_head(boundary, name, io.original_filename, io.content_type, file_length,
+                       io.respond_to?(:opts) ? io.opts : {}) 
+    @length = @head.length + file_length
+    @io = CompositeReadIO.new(StringIO.new(@head), io, StringIO.new("\r\n"))
+  end 
+end

data/lib/faraday/raise_http_exception.rb

@@ -0,0 +1,52 @@
+require 'faraday'
+
+# @private
+module FaradayMiddleware
+  # @private
+  class RaiseHttpException < Faraday::Middleware
+    def call(env)
+      @app.call(env).on_complete do |response|
+        p response
+        case response[:status].to_i
+        when 400
+          raise Douban::BadRequest, error_message_400(response)
+        when 404
+          raise Douban::NotFound, error_message_400(response)
+        when 500
+          raise Douban::InternalServerError, error_message_500(response, "Something is technically wrong.")
+        when 503
+          raise Douban::ServiceUnavailable, error_message_500(response, "Douban is rate limiting your requests.")
+        end
+      end
+    end
+
+    def initialize(app)
+      super app
+      @parser = nil
+    end
+
+    private
+
+    def error_message_400(response)
+      "#{response[:method].to_s.upcase} #{response[:url].to_s}: #{response[:status]}#{error_body(response[:body])}"
+    end
+
+    def error_body(body)
+      # body gets passed as a string, not sure if it is passed as something else from other spots?
+      if not body.nil? and not body.empty? and body.kind_of?(String)
+        # removed multi_json thanks to wesnolte's commit
+        body = ::JSON.parse(body)
+      end
+
+      if body.nil?
+        nil
+      elsif body['meta'] and body['meta']['error_message'] and not body['meta']['error_message'].empty?
+        ": #{body['meta']['error_message']}"
+      end
+    end
+
+    def error_message_500(response, body=nil)
+      "#{response[:method].to_s.upcase} #{response[:url].to_s}: #{[response[:status].to_s + ':', body].compact.join(' ')}"
+    end
+  end
+end

metadata

@@ -0,0 +1,268 @@
+--- !ruby/object:Gem::Specification
+name: douban_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Sean Lee
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !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.0.3
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: bluecloth
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.11
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.11
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: yard
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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 Douban API v2 based on instagram's official ruby
+  gem
+email:
+- iseansay@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.md
+- Rakefile
+- douban_api.gemspec
+- lib/douban_api.rb
+- lib/douban_api/api.rb
+- lib/douban_api/client.rb
+- lib/douban_api/client/album.rb
+- lib/douban_api/client/book.rb
+- lib/douban_api/client/comment.rb
+- lib/douban_api/client/discussion.rb
+- lib/douban_api/client/doumail.rb
+- lib/douban_api/client/event.rb
+- lib/douban_api/client/movie.rb
+- lib/douban_api/client/music.rb
+- lib/douban_api/client/note.rb
+- lib/douban_api/client/online.rb
+- lib/douban_api/client/shuo.rb
+- lib/douban_api/client/user.rb
+- lib/douban_api/client/utils.rb
+- lib/douban_api/configuration.rb
+- lib/douban_api/connection.rb
+- lib/douban_api/error.rb
+- lib/douban_api/oauth.rb
+- lib/douban_api/request.rb
+- lib/douban_api/version.rb
+- lib/faraday/oauth2.rb
+- lib/faraday/parts/filepart.rb
+- lib/faraday/raise_http_exception.rb
+homepage: 
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 4030718453987531716
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Ruby wrapper for the Douban API v2
+test_files: []
+has_rdoc: