aliexpress 0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 72fe66faf65e1f93edd912f2ba24148ca70c5ae1
+  data.tar.gz: 5ec3aa35f98e2deea15312fd5d243169d281dd43
+SHA512:
+  metadata.gz: db423a70fbb44d9063a2e7e5f809aaa3948a0bf7bbf7bcd5ea69bb7b53e53d75e3e77de01cf51d509eafcd193182d3f635b754b060fdc7b902f5f49b96344cec
+  data.tar.gz: 2caf268645d24586782369475cb5437e7ced287508746db1e4afa52616df55130638dd558bfb51b5f4ae1101f6046ca26e2b9ef5ec4a9fd524e14a0e6255c8a2

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,11 @@
+*.gem
+/Gemfile.lock
+/.approvals
+/.bundle
+/coverage
+.DS_Store
+
+/.client_id
+/.client_secret
+/.access_token
+/.refresh_token

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,38 @@
+AllCops:
+  TargetRubyVersion: 2.2
+
+Metrics/AbcSize:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Metrics/LineLength:
+  Enabled: false
+Metrics/ClassLength:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Metrics/BlockLength:
+  Enabled: false
+Metrics/ParameterLists:
+  Enabled: false
+
+Lint/EndAlignment:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+Style/IndentationWidth:
+  Enabled: false
+Style/ElseAlignment:
+  Enabled: false
+Style/GuardClause:
+  Enabled: false
+Style/NumericLiterals:
+  Enabled: false
+
+# This is temporary - it can be remove after updating rubocop to the latest.
+Style/PercentLiteralDelimiters:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+ - 2.2
+# branches:
+#   only:
+#     - master
+script:
+  - bundle exec rubocop
+  - bundle exec rake
+cache: bundler

data/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+gemspec
+
+group :development, :test do
+  gem 'awesome_print'
+  gem 'pry'
+  gem 'rake'
+  gem 'rubocop'
+end
+
+group :test do
+  gem 'coveralls', require: false
+  gem 'rspec'
+  gem 'webmock'
+end

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Tophatter
+
+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,117 @@
+[![Build Status](https://travis-ci.org/tophatter/aliexpress-api-ruby.svg?branch=master)](https://travis-ci.org/tophatter/aliexpress-api-ruby)
+[![Coverage Status](https://coveralls.io/repos/github/tophatter/aliexpress-api-ruby/badge.svg?branch=master)](https://coveralls.io/github/tophatter/aliexpress-api-ruby?branch=master)
+
+### AliExpress SDK for Ruby:
+
+#### Authentication:
+
+To use this SDK, you must have an app key and app secret (a.k.a. client id and client secret). These can be obtained [here](https://portals.aliexpress.com/adcenter/apiSetting.htm) if you're using the affiliate program, or [here](http://isvus.aliexpress.com/isv/index.htm) if you're using the ISV API.
+
+In the affiliate program API settings, you'll see the following:
+
+![](https://i.imgur.com/ycMNgMY.png)
+
+The "api key" is your client id, and the "digital signature" is your client secret.
+
+The API uses OAuth for authentication. You need to first go through a manual authorization sequence to get a short-live authorization code. That code can be exchanged for an access token that last 10 hours, and a refresh token that lasts significantly longer.
+
+Using this gem's console, you get obtain an access token as follows:
+
+```
+bash $ bin/console
+[1] pry(main)> AliExpress.client_id = [YOUR CLIENT ID]
+[2] pry(main)> AliExpress.client_secret = [YOUR CLIENT SECRET]
+[3] pry(main)> AliExpress::Auth.authorize
+Open https://gw.api.alibaba.com/auth/authorize.htm?_aop_signature=REDACTED&client_id=REDACTED&redirect_uri=REDACTED&site=aliexpress&state=REDACTED in your browser, and then enter the code below.
+authorization_code> [ENTER YOUR CODE HERE]
+{
+    "refresh_token_timeout" => "20180402143144000-0700",
+                    "aliId" => "[REDACTED]",
+           "resource_owner" => "[REDACTED]",
+              :access_token => "[REDACTED]",
+             :refresh_token => "[REDACTED]",
+                :expires_at => 1507194954
+}
+```
+
+Once your tokens are obtained, you can instruct this SDK to use them:
+
+```
+AliExpress.access_token = [YOUR ACCESS TOKEN]
+AliExpress.refresh_token = [YOUR REFRESH TOKEN]
+```
+
+If your access token expires, you can get a new one with the following:
+
+```
+AliExpress::Auth.refresh
+```
+
+#### Affiliate API:
+
+##### api.listPromotionProduct
+
+```
+[1] pry(main)> AliExpress::Affiliate.list_promotion_product(keywords: 'drone')
+D, [2017-10-05T11:23:03.971387 #69079] DEBUG -- : GET https://gw.api.alibaba.com/openapi/param2/2/portals.open/api.listPromotionProduct/[REDACTED]?fields=productId%2CproductTitle%2CproductUrl%2CimageUrl%2CallImageUrls%2CoriginalPrice%2CsalePrice%2ClocalPrice%2Cdiscount%2Cvolume%2CpackageType%2ClotNum%2CvalidTime&keywords=drone
+[
+    [ 0] {
+               "lotNum" => 1,
+          "packageType" => "piece",
+             "imageUrl" => "https://ae01.alicdn.com/kf/HTB1nxEjSFXXXXcDXpXXq6xXFXXXF/100-Original-SYMA-X5C-Upgrade-Version-RC-font-b-Drone-b-font-With-2MP-HD-Camera.jpg",
+         "allImageUrls" => "https://ae01.alicdn.com/kf/HTB1nxEjSFXXXXcDXpXXq6xXFXXXF/100-Original-SYMA-X5C-Upgrade-Version-RC-font-b-Drone-b-font-With-2MP-HD-Camera.jpg,https://ae01.alicdn.com/kf/HTB1O6LUSFXXXXX5aXXXq6xXFXXXB/100-Original-SYMA-X5C-Upgrade-Version-RC-font-b-Drone-b-font-With-2MP-HD-Camera.jpg,https://ae01.alicdn.com/kf/HTB1aA.DSFXXXXXgXXXXq6xXFXXX3/100-Original-SYMA-X5C-Upgrade-Version-RC-font-b-Drone-b-font-With-2MP-HD-Camera.jpg,https://ae01.alicdn.com/kf/HTB1N.kySFXXXXaUXXXXq6xXFXXXF/100-Original-SYMA-X5C-Upgrade-Version-RC-font-b-Drone-b-font-With-2MP-HD-Camera.jpg,https://ae01.alicdn.com/kf/HTB1lc_1SFXXXXcgXVXXq6xXFXXX9/100-Original-SYMA-X5C-Upgrade-Version-RC-font-b-Drone-b-font-With-2MP-HD-Camera.jpg,https://ae01.alicdn.com/kf/HTB16lEkSFXXXXcpXpXXq6xXFXXXK/100-Original-SYMA-X5C-Upgrade-Version-RC-font-b-Drone-b-font-With-2MP-HD-Camera.jpg",
+            "productId" => 32817202058,
+             "discount" => "5%",
+        "originalPrice" => "US $27.99",
+         "productTitle" => "100% Original SYMA X5C (Upgrade Version) RC <font><b>Drone</b></font> With 2MP HD Camera 6-Axis RC Quadcopter Helicopter X5 Dron Without Camera",
+            "validTime" => "2017-10-08",
+           "productUrl" => "https://www.aliexpress.com/item/SYMA-X5C-1-Upgrade-Version-SYMA-X5C-Professional-RC-Drone-6-Axis-Helicopter-Quadcopter-With-2MP/32817202058.html",
+               "volume" => "14",
+            "salePrice" => "US $26.59"
+    },
+    <snip>
+```
+
+##### api.getPromotionProductDetail
+
+```
+[1] pry(main)> AliExpress::Affiliate.get_promotion_product_detail(32817202058)
+D, [2017-10-05T11:24:19.235970 #69079] DEBUG -- : GET https://gw.api.alibaba.com/openapi/param2/2/portals.open/api.getPromotionProductDetail/[REDACTED]?fields=productId%2CproductTitle%2CproductUrl%2CimageUrl%2CallImageUrls%2CoriginalPrice%2CsalePrice%2ClocalPrice%2Cdiscount%2Cvolume%2CpackageType%2ClotNum%2CvalidTime&productId=32817202058
+{
+           "lotNum" => 1,
+      "packageType" => "piece",
+         "imageUrl" => "https://ae01.alicdn.com/kf/HTB1nxEjSFXXXXcDXpXXq6xXFXXXF/100-Original-SYMA-X5C-Upgrade-Version-RC-Drone-With-2MP-HD-Camera-6-Axis-RC-Quadcopter.jpg",
+     "allImageUrls" => "https://ae01.alicdn.com/kf/HTB1nxEjSFXXXXcDXpXXq6xXFXXXF/100-Original-SYMA-X5C-Upgrade-Version-RC-Drone-With-2MP-HD-Camera-6-Axis-RC-Quadcopter.jpg,https://ae01.alicdn.com/kf/HTB1O6LUSFXXXXX5aXXXq6xXFXXXB/100-Original-SYMA-X5C-Upgrade-Version-RC-Drone-With-2MP-HD-Camera-6-Axis-RC-Quadcopter.jpg,https://ae01.alicdn.com/kf/HTB1aA.DSFXXXXXgXXXXq6xXFXXX3/100-Original-SYMA-X5C-Upgrade-Version-RC-Drone-With-2MP-HD-Camera-6-Axis-RC-Quadcopter.jpg,https://ae01.alicdn.com/kf/HTB1N.kySFXXXXaUXXXXq6xXFXXXF/100-Original-SYMA-X5C-Upgrade-Version-RC-Drone-With-2MP-HD-Camera-6-Axis-RC-Quadcopter.jpg,https://ae01.alicdn.com/kf/HTB1lc_1SFXXXXcgXVXXq6xXFXXX9/100-Original-SYMA-X5C-Upgrade-Version-RC-Drone-With-2MP-HD-Camera-6-Axis-RC-Quadcopter.jpg,https://ae01.alicdn.com/kf/HTB16lEkSFXXXXcpXpXXq6xXFXXXK/100-Original-SYMA-X5C-Upgrade-Version-RC-Drone-With-2MP-HD-Camera-6-Axis-RC-Quadcopter.jpg",
+        "productId" => 32817202058,
+         "discount" => "5%",
+    "originalPrice" => "US $27.99",
+     "productTitle" => "100% Original SYMA X5C (Upgrade Version) RC Drone With 2MP HD Camera 6-Axis RC Quadcopter Helicopter X5 Dron Without Camera",
+        "validTime" => "2017-10-08",
+       "productUrl" => "https://www.aliexpress.com/item/SYMA-X5C-1-Upgrade-Version-SYMA-X5C-Professional-RC-Drone-6-Axis-Helicopter-Quadcopter-With-2MP/32817202058.html",
+           "volume" => "14",
+        "salePrice" => "US $26.59"
+}
+```
+
+##### api.listHotProducts
+
+```
+[1] pry(main)> AliExpress::Affiliate.list_hot_products(3)
+D, [2017-10-05T11:21:54.835675 #68982] DEBUG -- : GET https://gw.api.alibaba.com/openapi/param2/2/portals.open/api.listHotProducts/[REDACTED]?categoryId=3&language=en&localCurrency=USD
+[
+    [ 0] {
+          "localPrice" => "21.00 $",
+            "imageUrl" => "https://ae01.alicdn.com/kf/HTB1YsQwQFXXXXcvXpXXq6xXFXXX0/Preself-Hoodies-Sweatshirt-Women-Casual-Outwear-Hoody-Loose-Long-Sleeve-Mantle-Hooded-Cover-Pullover-Clothes-2017.jpg",
+          "productUrl" => "https://www.aliexpress.com/item/New-Women-Loose-Fashion-Autumn-Winter-Hooded-Oversize-Sweatshirt-Coat-Outwear/32763830156.html",
+           "validTime" => "2017-10-18",
+        "productTitle" => "Preself Hoodies Sweatshirt Women Casual Outwear Hoody Loose Long Sleeve Mantle Hooded Cover Pullover Clothes 2017 New",
+              "volume" => "",
+           "salePrice" => "US $21.00",
+           "productId" => 32763830156
+    },
+    <snip>
+```
+
+#### ISV API:
+
+In progress.

data/Rakefile

@@ -0,0 +1,3 @@
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/aliexpress.gemspec

@@ -0,0 +1,29 @@
+# To publish the next version:
+# gem build aliexpress.gemspec
+# gem push aliexpress-{VERSION}.gem
+Gem::Specification.new do |s|
+  s.name        = 'aliexpress'
+  s.version     = '0.4'
+  s.platform    = Gem::Platform::RUBY
+  s.licenses    = ['MIT']
+  s.authors     = ['Chris Estreich']
+  s.email       = ['chris@tophatter.com']
+  s.homepage    = 'https://github.com/tophatter/aliexpress-api-ruby'
+  s.summary     = 'AliExpress SDK for ruby.'
+  s.description = 'AliExpress SDK for ruby.'
+
+  s.extra_rdoc_files = ['README.md']
+
+  s.required_ruby_version = '~> 2.0'
+
+  s.add_dependency 'rest-client', '~> 1.6'
+  s.add_dependency 'addressable'
+  s.add_dependency 'oauth2'
+
+  s.post_install_message = 'Documentation is available at: http://isvus.aliexpress.com/isv/index.htm'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ['lib']
+end

data/bin/console

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup' # Otherwise "require 'aliexpress'" won't work.
+require 'aliexpress'
+require 'awesome_print'
+require 'pry'
+
+%w(client_id client_secret access_token refresh_token).each do |method|
+  begin
+    AliExpress.send("#{method}=", File.read(".#{method}").chomp)
+    puts "AliExpress.#{method}: #{AliExpress.send(method)}"
+  rescue Errno::ENOENT
+    puts "No .#{method} file, using default: #{AliExpress.send(method)}"
+  end
+end
+
+AliExpress.logger = Logger.new(STDOUT)
+AliExpress.logger.level = Logger::DEBUG
+
+AwesomePrint.pry!
+Pry.start

data/lib/aliexpress.rb

@@ -0,0 +1,45 @@
+require 'json'
+require 'rest-client'
+require 'addressable'
+require 'oauth2'
+
+module AliExpress
+  class << self
+    attr_accessor :client_id, :client_secret, :access_token, :refresh_token
+
+    attr_writer :protocol, :host, :base_uri
+    attr_writer :currency, :language
+    attr_writer :logger
+
+    def protocol
+      @protocol || 'https'
+    end
+
+    def host
+      @host || 'gw.api.alibaba.com'
+    end
+
+    def base_uri
+      @base_uri || "#{protocol}://#{host}/openapi"
+    end
+
+    def currency
+      @currency || 'USD'
+    end
+
+    def language
+      @language || 'en'
+    end
+
+    def logger
+      @logger ||= Logger.new('/dev/null')
+      @logger
+    end
+  end
+end
+
+require File.dirname(__FILE__) + '/aliexpress/base'
+require File.dirname(__FILE__) + '/aliexpress/response_error'
+require File.dirname(__FILE__) + '/aliexpress/auth'
+require File.dirname(__FILE__) + '/aliexpress/product'
+require File.dirname(__FILE__) + '/aliexpress/affiliate'

data/lib/aliexpress/affiliate.rb

@@ -0,0 +1,141 @@
+module AliExpress
+  class Affiliate < Base
+    CATEGORIES = {
+      'Apparel & Accessories' => 3,
+      'Automobiles & Motorcycles' => 34,
+      'Beauty & Health' => 66,
+      'Books for Local Russian' => 200004360,
+      'Computer & Office' => 7,
+      'Home Improvement' => 13,
+      'Consumer Electronics' => 44,
+      'Electrical Equipment & Supplies' => 5,
+      'Electronic Components & Supplies' => 502,
+      'Food' => 2,
+      'Furniture' => 1503,
+      'Hair & Accessories' => 200003655,
+      'Hardware' => 42,
+      'Home & Garden' => 15,
+      'Home Appliances' => 6,
+      'Industry & Business' => 200001996,
+      'Jewelry & Accessories' => 36,
+      'Lights & Lighting' => 39,
+      'Luggage & Bags' => 1524,
+      'Mother & Kids' => 1501,
+      'Office & School Supplies' => 21,
+      'Phones & Telecommunications' => 509,
+      'Security & Protection' => 30,
+      'Shoes' => 322,
+      'Special Category' => 200001075,
+      'Sports & Entertainment' => 18,
+      'Tools' => 1420,
+      'Toys & Hobbies' => 26,
+      'Travel and Coupon Services' => 200003498,
+      'Watches' => 1511,
+      'Weddings & Events' => 320
+    }.freeze
+
+    FILTERS = %w(category keywords min_price max_price high_quality).freeze
+    SORTS   = %w(orignalPriceUp orignalPriceDown sellerRateUp sellerRateDown).freeze
+    FIELDS  = %w(productId productTitle productUrl imageUrl allImageUrls originalPrice salePrice localPrice discount volume).freeze
+
+    SUCCESS = 20010000
+    ERRORS  = {
+      20020000 => 'System error.',
+      20030000 => 'Unauthorized transfer request.',
+      20030010 => 'Required parameters.',
+      20030020 => 'Invalid protocol format.',
+      20030030 => 'API version input parameter error.',
+      20030040 => 'API namespace input parameter error.',
+      20030050 => 'API name input parameter error.',
+      20030060 => 'Fields input parameter error.',
+      20030070 => 'Keyword input parameter error.',
+      20030080 => 'Category ID input parameter error.',
+      20030140 => 'Page number input parameter error.',
+      20030150 => 'Page size input parameter error (default = 20, max = 40).',
+      20030160 => 'Sort input parameter error.'
+    }.freeze
+
+    class << self
+      def search(query:, filters: {}, sort: 'orignalPriceUp', page: nil, per_page: 40, fields: FIELDS)
+        response = get(
+          api_call: 'api.listPromotionProduct',
+          params: {
+            keywords: query,
+            # filters
+            categoryId: CATEGORIES[filters[:category]] || filters[:category],
+            originalPriceFrom: filters[:min_price],
+            originalPriceTo: filters[:max_price],
+            highQualityItems: filters[:high_quality],
+            # sorting
+            sort: sort,
+            # paging
+            pageNo: page,
+            pageSize: per_page,
+            # response format
+            fields: fields.join(',')
+          }.delete_if { |_k, v| v.nil? }
+        )
+
+        raise_response_error(response) unless response['errorCode'] == SUCCESS
+        response
+      end
+
+      def find(id, fields: FIELDS)
+        response = get(
+          api_call: 'api.getPromotionProductDetail',
+          params: { productId: id, fields: fields.join(',') }
+        )
+
+        raise_response_error(response) unless response['errorCode'] == SUCCESS
+        response
+      end
+
+      def similar(id)
+        response = get(
+          api_call: 'api.listSimilarProducts',
+          params: { productId: id }
+        )
+
+        raise_response_error(response) unless response['errorCode'] == SUCCESS
+        response
+      end
+
+      def popular(category)
+        response = get(
+          api_call: 'api.listHotProducts',
+          params: { categoryId: CATEGORIES[category] || category }
+        )
+
+        raise_response_error(response) unless response['errorCode'] == SUCCESS
+        response
+      end
+
+      private
+
+      def get(hash)
+        defaults = {
+          api_namespace: 'portals.open',
+          api_version: 2,
+          auth: false,
+          sign: false,
+          params: {
+            localCurrency: currency,
+            language: language
+          }
+        }
+        params = defaults[:params].merge(hash.delete(:params))
+        super(defaults.merge(hash).merge(params: params))
+      end
+
+      def raise_response_error(response)
+        exception = ResponseError.new(
+          code: response['error_code'] || response['errorCode'],
+          message: response['error_message'] || ERRORS[response['errorCode']] || response['errorCode'],
+          response: response
+        )
+
+        raise exception
+      end
+    end
+  end
+end

data/lib/aliexpress/auth.rb

@@ -0,0 +1,86 @@
+module AliExpress
+  class Auth < Base
+    class << self
+      def authorize(state = nil)
+        oauth_client = client
+        oauth_params = params(state || SecureRandom.hex(24))
+        oauth_params[:_aop_signature] = sign(oauth_params)
+        logger.debug oauth_params
+        url = oauth_client.authorize_url(oauth_params)
+
+        if RUBY_PLATFORM == 'x86_64-darwin16'
+          begin
+            system('open', url)
+          rescue Exception => e # rubocop:disable Lint/RescueException
+            logger.debug "Call to open failed: #{e.message}"
+          end
+        end
+
+        $stdout.puts "Open #{url} in your browser, and then enter the code below."
+        $stdout.print 'authorization_code> '
+        authorization_code = $stdin.gets
+
+        token = oauth_client.get_token(
+          code: authorization_code,
+          grant_type: 'authorization_code',
+          need_refresh_token: 'true',
+          parse: :json,
+          redirect_uri: 'urn:ietf:wg:oauth:2.0:oob'
+        ).to_hash
+
+        token
+      end
+
+      def refresh
+        if refresh_token
+          response = post(
+            api_call: 'getToken',
+            api_namespace: 'system.oauth2',
+            api_version: '1',
+            # protocol: 'http',
+            auth: false,
+            sign: false,
+            params: {
+              grant_type: 'refresh_token',
+              client_id: client_id,
+              client_secret: client_secret,
+              refresh_token: refresh_token
+            }
+          )
+          AliExpress.access_token = response['access_token']
+        else
+          raise Exception, 'You must have a refresh_token to refresh authorization. You need to call `AliExpress::Auth.authorize` and follow the instructions to generate one.'
+        end
+      end
+
+      private
+
+      def client
+        OAuth2::Client.new(
+          client_id,
+          client_secret,
+          site: 'https://gw.api.alibaba.com',
+          authorize_url: '/auth/authorize.htm',
+          token_url: "/openapi/http/1/system.oauth2/getToken/#{client_id}"
+        )
+      end
+
+      def sign(hash)
+        OpenSSL::HMAC.hexdigest(
+          OpenSSL::Digest.new('sha1'),
+          client_secret,
+          hash.sort.flatten.join.to_s
+        ).upcase
+      end
+
+      def params(state)
+        {
+          client_id: client_id,
+          redirect_uri: 'urn:ietf:wg:oauth:2.0:oob',
+          site: 'aliexpress',
+          state: state
+        }
+      end
+    end
+  end
+end

data/lib/aliexpress/base.rb

@@ -0,0 +1,87 @@
+module AliExpress
+  class Base
+    class << self
+      def client_id
+        AliExpress.client_id
+      end
+
+      def client_secret
+        AliExpress.client_secret
+      end
+
+      def access_token
+        AliExpress.access_token
+      end
+
+      def refresh_token
+        AliExpress.refresh_token
+      end
+
+      def currency
+        AliExpress.currency
+      end
+
+      def language
+        AliExpress.language
+      end
+
+      def logger
+        AliExpress.logger
+      end
+
+      def get(params)
+        request(params.merge(method: :get))
+      end
+
+      def post(params)
+        request(params.merge(method: :post))
+      end
+
+      private
+
+      def sign_payload(path, payload)
+        signature_factor = path + payload.map { |key, value| "#{key}#{value}" }.sort.join
+        payload[:_aop_signature] = OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha1'), client_secret, signature_factor).upcase
+        logger.debug "signature_factor=#{signature_factor}, signature=#{payload[:_aop_signature]}"
+      end
+
+      def request(method:, protocol: 'param2', api_version: 1, api_namespace: 'aliexpress.open', api_call:, auth: true, sign: true, params: {})
+        path = [protocol, api_version, api_namespace, api_call, client_id].join('/')
+
+        payload = params
+        payload[:access_token] = access_token if auth
+        sign_payload(path, payload) if sign
+        url = [AliExpress.base_uri, path].join('/')
+
+        resp = if method == :get
+          unless params.length.zero?
+            uri = Addressable::URI.new
+            uri.query_values = params
+            url += "?#{uri.query}"
+          end
+
+          logger.debug "GET #{url}"
+          RestClient.get(url)
+        else
+          logger.debug "POST #{url} | #{payload}"
+          RestClient.post(url, payload)
+        end
+
+        begin
+          JSON.parse(resp.body)
+        rescue JSON::ParserError
+          resp.body
+        end
+      rescue RestClient::Exception => exception
+        resp = begin
+          JSON.parse(exception.response)
+        rescue JSON::ParserError
+          exception.response
+        end
+
+        logger.debug "#{exception.class.name} (#{exception.response.code}): #{resp.inspect}"
+        resp
+      end
+    end
+  end
+end

data/lib/aliexpress/product.rb

@@ -0,0 +1,22 @@
+module AliExpress
+  class Product < Base
+    class << self
+      def find(id)
+        post(api_call: 'api.findAeProductById', params: { productId: id })
+      end
+
+      private
+
+      def get(params)
+        super(default_params.merge(params))
+      end
+
+      def default_params
+        {
+          api_namespace: 'aliexpress.open',
+          api_version: 1
+        }
+      end
+    end
+  end
+end

data/lib/aliexpress/response_error.rb

@@ -0,0 +1,11 @@
+module AliExpress
+  class ResponseError < StandardError
+    attr_reader :code, :message, :response
+
+    def initialize(code:, message:, response:)
+      @code     = code
+      @message  = message
+      @response = response
+    end
+  end
+end

data/spec/affiliate_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+# rspec spec/affiliate_spec.rb
+describe AliExpress::Affiliate do
+  let(:response) do
+    mock = double
+    allow(mock).to receive(:code).and_return(200)
+    allow(mock).to receive(:body).and_return(json)
+    mock
+  end
+
+  let(:success) { 20010000 }
+  let(:hash) { { 'errorCode' => success } }
+  let(:json) { hash.to_json }
+
+  # before do
+  #   AliExpress.logger = Logger.new(STDOUT)
+  #   AliExpress.logger.level = Logger::DEBUG
+  # end
+
+  describe '.search' do
+    let(:url) { 'https://gw.api.alibaba.com/openapi/param2/2/portals.open/api.listPromotionProduct/fake-client-id?categoryId=3&fields=productId&keywords=drone&language=en&localCurrency=USD&pageNo=2&pageSize=5&sort=orignalPriceDown' }
+
+    it 'returns a successful response' do
+      expect(RestClient).to receive(:get).exactly(1).times.with(url).and_return(response)
+      response = AliExpress::Affiliate.search(query: 'drone', filters: { category: 'Apparel & Accessories' }, sort: 'orignalPriceDown', page: 2, per_page: 5, fields: %w(productId))
+      expect(response['errorCode']).to eq(success)
+    end
+  end
+
+  describe '.find' do
+    let(:url) { 'https://gw.api.alibaba.com/openapi/param2/2/portals.open/api.getPromotionProductDetail/fake-client-id?fields=productId&language=en&localCurrency=USD&productId=12345' }
+
+    it 'returns a product' do
+      expect(RestClient).to receive(:get).exactly(1).times.with(url).and_return(response)
+      response = AliExpress::Affiliate.find(12345, fields: %w(productId))
+      expect(response['errorCode']).to eq(success)
+    end
+  end
+
+  describe '.similar' do
+    let(:url) { 'https://gw.api.alibaba.com/openapi/param2/2/portals.open/api.listSimilarProducts/fake-client-id?language=en&localCurrency=USD&productId=12345' }
+
+    it 'returns a product' do
+      expect(RestClient).to receive(:get).exactly(1).times.with(url).and_return(response)
+      response = AliExpress::Affiliate.similar(12345)
+      expect(response['errorCode']).to eq(success)
+    end
+  end
+
+  describe '.popular' do
+    let(:url) { 'https://gw.api.alibaba.com/openapi/param2/2/portals.open/api.listHotProducts/fake-client-id?categoryId=3&language=en&localCurrency=USD' }
+
+    context 'when a category id is used' do
+      it 'returns a successful response' do
+        expect(RestClient).to receive(:get).exactly(1).times.with(url).and_return(response)
+        response = AliExpress::Affiliate.popular(3)
+        expect(response['errorCode']).to eq(success)
+      end
+    end
+
+    context 'when a category name is used' do
+      it 'returns a successful response' do
+        expect(RestClient).to receive(:get).exactly(1).times.with(url).and_return(response)
+        response = AliExpress::Affiliate.popular('Apparel & Accessories')
+        expect(response['errorCode']).to eq(success)
+      end
+    end
+  end
+end

data/spec/aliexpress_spec.rb

@@ -0,0 +1,94 @@
+require 'spec_helper'
+
+# rspec spec/aliexpress_spec.rb
+describe AliExpress do
+  describe '.client_id' do
+    subject { AliExpress.client_id }
+    it { is_expected.to eq('fake-client-id') }
+
+    context('when assigned') do
+      before { AliExpress.client_id = 'foo' }
+      it { is_expected.to eq('foo') }
+    end
+  end
+
+  describe '.client_secret' do
+    subject { AliExpress.client_secret }
+    it { is_expected.to eq('fake-client-secret') }
+
+    context('when assigned') do
+      before { AliExpress.client_secret = 'foo' }
+      it { is_expected.to eq('foo') }
+    end
+  end
+
+  describe '.access_token' do
+    subject { AliExpress.access_token }
+    it { is_expected.to eq('fake-access-token') }
+
+    context('when assigned') do
+      before { AliExpress.access_token = 'foo' }
+      it { is_expected.to eq('foo') }
+    end
+  end
+
+  describe '.refresh_token' do
+    subject { AliExpress.refresh_token }
+    it { is_expected.to eq('fake-refresh-token') }
+
+    context('when assigned') do
+      before { AliExpress.refresh_token = 'foo' }
+      it { is_expected.to eq('foo') }
+    end
+  end
+
+  describe '.protocol' do
+    subject { AliExpress.protocol }
+    it { is_expected.to eq('https') }
+
+    context('when assigned') do
+      before { AliExpress.protocol = 'foo' }
+      it { is_expected.to eq('foo') }
+    end
+  end
+
+  describe '.host' do
+    subject { AliExpress.host }
+    it { is_expected.to eq('gw.api.alibaba.com') }
+
+    context('when assigned') do
+      before { AliExpress.host = 'foo' }
+      it { is_expected.to eq('foo') }
+    end
+  end
+
+  describe '.base_uri' do
+    subject { AliExpress.base_uri }
+    it { is_expected.to eq('https://gw.api.alibaba.com/openapi') }
+
+    context('when assigned') do
+      before { AliExpress.base_uri = 'foo' }
+      it { is_expected.to eq('foo') }
+    end
+  end
+
+  describe '.currency' do
+    subject { AliExpress.currency }
+    it { is_expected.to eq('USD') }
+
+    context('when assigned') do
+      before { AliExpress.currency = 'foo' }
+      it { is_expected.to eq('foo') }
+    end
+  end
+
+  describe '.language' do
+    subject { AliExpress.language }
+    it { is_expected.to eq('en') }
+
+    context('when assigned') do
+      before { AliExpress.language = 'foo' }
+      it { is_expected.to eq('foo') }
+    end
+  end
+end

data/spec/auth_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+# rspec spec/auth_spec.rb
+describe AliExpress::Auth do
+  describe '.authorize' do
+    let(:authorization_code) { 'b5ce38e1-833c-4f15-bd29-65e85db9bd2e' }
+    let(:response) do
+      {
+        'refresh_token_timeout' => '20180402143144000-0700',
+        'aliId' => 'fake-ali-id',
+        'resource_owner' => 'fake-resource-owner',
+        access_token: 'new-fake-access-token',
+        refresh_token: 'new-fake-refresh-token',
+        expires_at: 1507266354
+      }
+    end
+
+    it 'creates a new access token' do
+      stub_const('RUBY_PLATFORM', 'test')
+      allow($stdin).to receive(:gets).and_return(authorization_code)
+      allow($stdout).to receive(:puts).and_return(nil)
+      allow($stdout).to receive(:print).and_return(nil)
+      expect_any_instance_of(OAuth2::Client).to receive(:get_token).exactly(1).times.with(hash_including(code: authorization_code)).and_return(response)
+      expect(AliExpress::Auth.authorize).to eq(response)
+    end
+  end
+
+  describe '.refresh' do
+    let(:response) do
+      mock = double
+      allow(mock).to receive(:code).and_return(200)
+      allow(mock).to receive(:body).and_return('{"aliId":"fake-ali-id","resource_owner":"fake-resource-owner","expires_in":"36000","access_token":"jabber_wocky"}')
+      mock
+    end
+
+    it 'exchanges the refresh token for a new access token' do
+      expect(RestClient).to receive(:post).exactly(1).times.and_return(response)
+      expect(AliExpress::Auth.refresh).to eq('jabber_wocky')
+    end
+  end
+end

data/spec/base_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+# rspec spec/base_spec.rb
+describe AliExpress::Base do
+  let(:response) do
+    mock = double
+    allow(mock).to receive(:code).and_return(200)
+    allow(mock).to receive(:body).and_return('{}')
+    mock
+  end
+
+  describe '.get' do
+    context 'when auth is true' do
+      it 'uses the access token' do
+        expect(RestClient).to receive(:get).exactly(1).times.with('https://gw.api.alibaba.com/openapi/param2/1/aliexpress.open/foo/fake-client-id?access_token=fake-access-token').and_return(response)
+        AliExpress::Base.get(api_call: 'foo', sign: false, auth: true)
+      end
+    end
+
+    context 'when sign is true' do
+      it 'signs the request' do
+        expect(RestClient).to receive(:get).exactly(1).times.with('https://gw.api.alibaba.com/openapi/param2/1/aliexpress.open/foo/fake-client-id?_aop_signature=8F19FBA00C4BF35E43FA9ED143639337047624C0').and_return(response)
+        AliExpress::Base.get(api_call: 'foo', sign: true, auth: false)
+      end
+    end
+
+    context 'when bogus params are used' do
+      it 'raises an error' do
+        expect { AliExpress::Base.get(api_call: 'foo', foo: 'bar') }.to raise_error(ArgumentError)
+      end
+    end
+  end
+
+  describe '.post' do
+    context 'when auth is true' do
+      it 'uses the access token' do
+        expect(RestClient).to receive(:post).exactly(1).times.with('https://gw.api.alibaba.com/openapi/param2/1/aliexpress.open/foo/fake-client-id', access_token: 'fake-access-token').and_return(response)
+        AliExpress::Base.post(api_call: 'foo', sign: false, auth: true)
+      end
+    end
+
+    context 'when sign is true' do
+      it 'signs the request' do
+        expect(RestClient).to receive(:post).exactly(1).times.with('https://gw.api.alibaba.com/openapi/param2/1/aliexpress.open/foo/fake-client-id', _aop_signature: '8F19FBA00C4BF35E43FA9ED143639337047624C0').and_return(response)
+        AliExpress::Base.post(api_call: 'foo', sign: true, auth: false)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'coveralls'
+Coveralls.wear!
+
+require 'aliexpress'
+require 'awesome_print'
+
+gemspec = Gem::Specification.find_by_name('aliexpress')
+Dir["#{gemspec.gem_dir}/spec/support/**/*.rb"].each { |f| require f }

data/spec/support/auth.rb

@@ -0,0 +1,12 @@
+RSpec.configure do |config|
+  config.before(:each) do
+    AliExpress.client_id     = 'fake-client-id'
+    AliExpress.client_secret = 'fake-client-secret'
+    AliExpress.access_token  = 'fake-access-token'
+    AliExpress.refresh_token = 'fake-refresh-token'
+
+    %i(protocol host base_uri currency language logger).each do |method|
+      AliExpress.send("#{method}=", nil)
+    end
+  end
+end

data/spec/support/webmock.rb

@@ -0,0 +1,3 @@
+require 'webmock/rspec'
+
+WebMock.disable_net_connect!(allow_localhost: true)

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: aliexpress
+version: !ruby/object:Gem::Version
+  version: '0.4'
+platform: ruby
+authors:
+- Chris Estreich
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-10-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  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: oauth2
+  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'
+description: AliExpress SDK for ruby.
+email:
+- chris@tophatter.com
+executables:
+- console
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- aliexpress.gemspec
+- bin/console
+- lib/aliexpress.rb
+- lib/aliexpress/affiliate.rb
+- lib/aliexpress/auth.rb
+- lib/aliexpress/base.rb
+- lib/aliexpress/product.rb
+- lib/aliexpress/response_error.rb
+- spec/affiliate_spec.rb
+- spec/aliexpress_spec.rb
+- spec/auth_spec.rb
+- spec/base_spec.rb
+- spec/spec_helper.rb
+- spec/support/auth.rb
+- spec/support/webmock.rb
+homepage: https://github.com/tophatter/aliexpress-api-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 'Documentation is available at: http://isvus.aliexpress.com/isv/index.htm'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: AliExpress SDK for ruby.
+test_files:
+- spec/affiliate_spec.rb
+- spec/aliexpress_spec.rb
+- spec/auth_spec.rb
+- spec/base_spec.rb
+- spec/spec_helper.rb
+- spec/support/auth.rb
+- spec/support/webmock.rb