open_jd 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c0a555f25e8092790f5c29b8a4b181f0206b1de9
+  data.tar.gz: 0e5a126d8c998fa25d825f4e40f3f69c74fdbccd
+SHA512:
+  metadata.gz: 23deca3dcbd96f27e91ffd5c1d20f72765bde3ad8daa2507bc01dd661e6b9a86413c3cc939a8ed2f546f17819ad06b0c07953bd7ef315348357399750bcc52e2
+  data.tar.gz: 8207fd72f6926fdc5de5a0e84e12680ee53ac5fd40cc0876e23fcfdc53ad9061bb3cfe11d75a5cdaffc63b3fe816af57f33db1e5f45c9d7abe6e2031fcc0cb4a

data/.gitignore

@@ -0,0 +1,51 @@
+.project
+.classpath
+.settings
+*.swp
+*.keep
+*.tmproj
+*.esproj
+*.chproj
+*.[oa]
+*~
+*.lock
+*.sublime-project
+*.sublime-workspace
+*.class
+
+# Xcode
+.DS_Store
+build/
+*.pbxuser
+!default.pbxuser
+*.mode1v3
+!default.mode1v3
+*.mode2v3
+!default.mode2v3
+*.perspectivev3
+!default.perspectivev3
+*.xcworkspace
+!default.xcworkspace
+xcuserdata
+profile
+*.moved-aside
+DerivedData
+.idea/
+*.rbc
+*.sassc
+.sass-cache
+capybara-*.html
+.rspec
+/.bundle
+/vendor/bundle
+/log/*
+/logs/*
+/tmp/*
+/db/*.sqlite3
+/public/system/*
+/coverage/
+/spec/tmp/*
+**.orig
+rerun.txt
+npm-debug.log
+pickle-email-*.html

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Justin Hao
+
+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,86 @@
+OpenJd
+==========
+
+JD Open Platform client for ruby. Rails3+ is supported.
+
+## NOTICE
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'open_jd'
+
+If you want to use [patron][] as http client instead of Net::HTTP, add line below to your Gemfile
+
+    gem 'patron'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install open_jd
+
+## Usage
+
+### Rails with yaml file configured
+
+Run generator to generate config file:
+
+    $ rails g open_jd:install
+
+It will generate a `jd.yml` file under your Rails' config dir.
+Open the file and configure it with your jd info.
+
+Notice: `app_key`, `secret_key`, `endpoint` must be included in your YAML file, otherwise OpenJd.load will fail.
+
+The `app_key` and `secret_key` are avaliable by `ENV['JD_API_KEY']`, `ENV['JD_SECRET_KEY']` out of the box if you use same keys for other jd related gems, e.g. omniauth-taobao.
+
+call `OpenJd.get` or `OpenJd.post`，with jd parameters：
+
+    hash = OpenJd.post(
+      method: 'jingdong.ware.product.detail.search.list.get',
+      fields: { skuId: params[:id], isLoadWareScore: false, client: 'm' }
+    )
+
+
+The return data will be converted to a Hash automatically.
+
+Also `OpenJd.get!` and `OpenJd.post!` are avaliable, which will raise an `OpenJd::Error` if a `error_response` receieved.
+
+### plain ruby
+
+    OpenJd.config = {
+      'app_key'    => 'test',
+      'secret_key' => 'test',
+      'endpoint'   => 'http://gw.api.jd.com/routerjson'
+    }
+
+    OpenJd.initialize_session
+
+    hash = OpenJd.get(
+      method: 'jingdong.ware.product.detail.search.list.get',
+      fields: { skuId: params[:id], isLoadWareScore: false, client: 'm' }
+    )
+
+### get query string
+
+If you want the query string with some params just pass the params to OpenJd.url() the same as OpenJd.get().
+The query string will change every time your executed because timestamps changed.
+
+    OpenJd.url(
+      method: 'jingdong.ware.product.detail.search.list.get',
+      fields: { skuId: params[:id], isLoadWareScore: false, client: 'm' }
+    )
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+[patron]: https://github.com/toland/patron

data/lib/generators/open_jd/install_generator.rb

@@ -0,0 +1,11 @@
+module OpenJd
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('../../templates', __FILE__)
+
+      def copy_yml_file
+        copy_file 'jd.yml', 'config/jd.yml'
+      end
+    end
+  end
+end

data/lib/generators/templates/jd.yml

@@ -0,0 +1,14 @@
+development:
+  app_key:    'test'
+  secret_key: 'test'
+  endpoint:   'http://gw.api.jd.com/routerjson'
+
+test:
+  app_key:    'test'
+  secret_key: 'test'
+  endpoint:   'http://gw.api.jd.com/routerjson'
+
+production:
+  app_key:    'test'
+  secret_key: 'test'
+  endpoint:   'http://gw.api.jd.com/routerjson'

data/lib/open_jd/hash_ext.rb

@@ -0,0 +1,7 @@
+require 'cgi'
+
+class Hash
+  def to_query
+    self.map { |k, v| "#{k.to_s}=#{CGI::escape(v.to_s)}" }.join('&')
+  end
+end

data/lib/open_jd/open_jd.rb

@@ -0,0 +1,165 @@
+module OpenJd
+  REQUEST_TIMEOUT = 10
+  API_VERSION = '2.0'
+  USER_AGENT = "open_jd-v#{VERSION}"
+  PARAMS_KEY = '360buy_param_json'
+  PRODUCT_LINK = 'http://item.jd.com'
+
+  class Error < StandardError; end
+
+  class << self
+    attr_accessor :config, :session
+
+    def jd_link(id)
+      "#{PRODUCT_LINK}/#{id}.html"
+    end
+
+    # Load a yml config, and initialize http session
+    # yml config file content should be:
+    #
+    #   app_key:    "YOUR APP KEY"
+    #   secret_key: "YOUR SECRET KEY"
+    #   endpoint:   "TAOBAO GATEWAY API URL"
+    #
+    def load(config_file)
+      @config = YAML.load_file(config_file)
+      @config = config[Rails.env] if defined? Rails
+      check_config_and_export_to_env
+      initialize_session
+    end
+
+    # check config and export all setting to ENV
+    def check_config_and_export_to_env
+      check_config
+      export_config_to_env
+    end
+
+    # check config
+    #
+    # raise exception if config key missed in YAML file
+    def check_config
+      list = []
+      %w(app_key secret_key endpoint).map do |k|
+        list << k unless config.key? k
+      end
+
+      raise "[#{list.join(', ')}] not included in your yaml file." unless list.empty?
+    end
+
+    # setting ENV variables from config
+    #
+    # ENV variables:
+    #
+    #   JD_API_KEY    -> config['app_key']
+    #   JD_SECRET_KEY -> config['secret_key']
+    #   JD_ENDPOINT   -> config['endpoint']
+    def export_config_to_env
+      ENV['JD_API_KEY']    = config['app_key']
+      ENV['JD_SECRET_KEY'] = config['secret_key']
+      ENV['JD_ENDPOINT']   = config['endpoint']
+    end
+
+    # Initialize http sesison
+    def initialize_session
+      @session = Faraday.new url: config['endpoint'] do |builder|
+        begin
+          require 'patron'
+          builder.adapter :patron
+        rescue LoadError
+          builder.adapter :net_http
+        end
+      end
+    end
+
+    # Return request signature with MD5 signature method
+    def sign(params)
+      Digest::MD5.hexdigest(wrap_with_secret sorted_option_string(params)).upcase
+    end
+
+    # wrapped with secret_key
+    def wrap_with_secret(s)
+      "#{config['secret_key']}#{s}#{config['secret_key']}"
+    end
+
+    # Return sorted request parameter by request key
+    def sorted_option_string(options)
+      options.map {|k, v| "#{k}#{v}" }.sort.join
+    end
+
+    # Merge custom parameters with JD system parameters.
+    #
+    # System paramters below will be merged. 
+    #
+    #   timestamp
+    #   v
+    #   format
+    #   sign_method
+    #   app_key
+    #   method
+    #   params_key
+    #
+    # Current JD API Version is '2.0'.
+    # <tt>format</tt> should be json.
+    # Only <tt>sign_method</tt> MD5 is supported so far.
+    def full_options(params)
+      {
+          timestamp:   Time.zone.now.strftime('%F %T'),
+          v:           API_VERSION,
+          format:      :json,
+          sign_method: :md5,
+          app_key:     config['app_key'],
+          method:      params[:method],
+          PARAMS_KEY:  params[:fields].to_json.to_s
+      }
+    end
+
+    def query_hash(params)
+      params = full_options params
+      params[:sign] = sign params
+      params
+    end
+
+    # Return query string with signature.
+    def query_string(params)
+      '?' + query_hash(params).to_query
+    end
+
+    # Return full url with signature.
+    def url(params)
+      format('%s%s', config['endpoint'], query_string(params))
+    end
+
+    # Return a parsed JSON object.
+    def parse_result(data)
+      MultiJson.decode(data)
+    end
+
+    # Request by get method and return result in JSON format
+    def get(params)
+      path = query_string(params)
+      parse_result session.get(path).body
+    end
+
+    # Request by get method and return result in JSON format
+    # Raise OpenTaobao::Error if returned with error_response
+    def get!(params)
+      response = get params
+      raise Error.new(MultiJson.encode response['error_response']) if response.has_key?('error_response')
+      response
+    end
+
+    # Request by post method and return result in JSON format
+    def post(params)
+      parse_result session.post('', query_hash(params).to_query).body
+    end
+
+    # Request by post method and return result in JSON format
+    # Raise OpenTaobao::Error if returned with error_response
+    def post!(params)
+      response = post params
+      raise Error.new(MultiJson.encode response['error_response']) if response.has_key?('error_response')
+      response
+    end
+  end
+end
+

data/lib/open_jd/railtie.rb

@@ -0,0 +1,14 @@
+require 'rails'
+
+module OpenJd
+  class Railtie < Rails::Railtie
+    generators do
+      require 'generators/open_jd/install_generator'
+    end
+
+    initializer 'load jd.yml' do
+      config_file = Rails.root + 'config/jd.yml'
+      OpenJd.load(config_file) if config_file.file?
+    end
+  end
+end

data/lib/open_jd/version.rb

@@ -0,0 +1,3 @@
+module OpenJd
+  VERSION = '0.0.1'
+end

data/lib/open_jd.rb

@@ -0,0 +1,10 @@
+require 'digest'
+require 'faraday'
+require 'multi_json'
+require 'yaml'
+
+require 'open_jd/version'
+require 'open_jd/hash_ext'
+require 'open_jd/open_jd'
+
+require 'open_jd/railtie' if defined? Rails

data/open_jd.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/open_jd/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ['Justin Hao']
+  gem.email         = ['justin@haoyufeng.com']
+  gem.description   = %q{京东开放平台 Ruby 版，支持Rails3+}
+  gem.summary       = %q{Open JD API for ruby}
+  gem.homepage      = 'http://github.com/mambahao/open_jd'
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = 'open_jd'
+  gem.license       = 'MIT'
+  gem.require_paths = ['lib']
+  gem.version       = OpenJd::VERSION
+
+  gem.add_dependency 'multi_json', '~> 0'
+  gem.add_dependency 'faraday', '~> 0'
+  gem.add_development_dependency 'rspec', '~> 0'
+  gem.add_development_dependency 'debugger', '~> 0'
+  gem.add_development_dependency 'autotest', '~> 0'
+  gem.add_development_dependency 'rake', '~> 0'
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: open_jd
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Justin Hao
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: autotest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: "京东开放平台 Ruby 版，支持Rails3+"
+email:
+- justin@haoyufeng.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- lib/generators/open_jd/install_generator.rb
+- lib/generators/templates/jd.yml
+- lib/open_jd.rb
+- lib/open_jd/hash_ext.rb
+- lib/open_jd/open_jd.rb
+- lib/open_jd/railtie.rb
+- lib/open_jd/version.rb
+- open_jd.gemspec
+homepage: http://github.com/mambahao/open_jd
+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.5
+signing_key: 
+specification_version: 4
+summary: Open JD API for ruby
+test_files: []