simple_gsx 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5664ac0ee9454d0046198c8b37ea07ea3c1e460a
+  data.tar.gz: 1a46140ee7172f15e5d8c6534ff83a6fe6a3c568
+SHA512:
+  metadata.gz: ea2889f932e8533cfc4afc2a0bbfd8175c9572989d7b4456c91c527a222248c5b26268f4387523aef71d2645b18abc3b7e10a2fa63f12b28a25cad0d058524d0
+  data.tar.gz: 5f4320f6a0fa70ed8c4cbe495969f070a81e96098263f774bd8d97e2b124260ea10318c39e849ffb37793328dc0358a4b91c8725d84dab047a2ae0d79f396342

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 zchar
+
+MIT License
+
+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,128 @@
+# SimpleGsx
+
+This gem is a Ruby library for communicating with Apple's GSX restful API.
+
+You can visit [this site](https://gsxwsut.apple.com/apidocs/acc/uat/html/WSReference.html?user=reseller&id=1111&lang=EN) to see the full API documents.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'simple_gsx'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simple_gsx
+
+## Getting Started
+
+In your project, initialize a GSX Client Object:
+
+```
+require 'simple_gsx'
+
+config = {
+	user_id: 	'YOUR_USER_ID',
+	password: 	'YOUR_PASSWORD',
+	ship_to: 	'YOUR_SHIP_TO_CODE',
+	cert_file:  '/PATH/TO/YOUR/CERT.pem',
+	lang_code:  'OPTIONAL, DEFAULT TO "zh"',
+	time_zone:  'OPTIONAL, DEFAULT TO "-480"'
+}
+
+gsx = SimpleGsx::Client.new(config)
+
+# 360 lookup API request
+lookup_params = {
+	device_id: 					'YOUR_APPLE_DEVICE_ID',
+	purchase_order_number: 		'OPTIONAL',
+	customer_email_id: 			'OPTIONAL'
+}
+device_info = gsx.order_lookup(lookup_params)
+```
+ 
+## Other instance methods
+
+###create_order
+
+```
+order_params = {
+	purchase_order_number: 		'YOUR SYSTEM ORDER NUMBER, MAX TO 13 LENGTH',
+	customer_first_name:   		'zheng',
+	customer_last_name: 		'xu',
+	customer_email: 			'zchar@mycolorway.com',
+	customer_address: 			'CUSTOMER ADDRESS',
+	customer_mobile_number: 	'CUSTOMER MOBILE NUMBER',
+	customer_zip_code: 			'OPTIONAL, CUSTOMER ZIP CODE',
+	device_id: 					'APPLE DEVICE ID',
+	created_at: 				Time.zone.now
+}
+gsx.create_order order_params
+```
+
+###cancel_order
+
+```
+order_params = {
+	purchase_order_number: 		'YOUR SYSTEM ORDER NUMBER, MAX TO 13 LENGTH',
+	customer_first_name:   		'zheng',
+	customer_last_name: 		'xu',
+	customer_email: 			'zchar@mycolorway.com',
+	customer_address: 			'CUSTOMER ADDRESS',
+	customer_mobile_number: 	'CUSTOMER MOBILE NUMBER',
+	customer_zip_code: 			'OPTIONAL, CUSTOMER ZIP CODE',
+	device_id: 					'APPLE DEVICE ID',
+	created_at: 				Time.zone.now
+}
+gsx.cancel_order order_params
+```
+###verify_order
+```
+order_params = {
+	purchase_order_number: 		'YOUR SYSTEM ORDER NUMBER, MAX TO 13 LENGTH',
+	customer_first_name:   		'zheng',
+	customer_last_name: 		'xu',
+	customer_email: 			'zchar@mycolorway.com',
+	customer_address: 			'CUSTOMER ADDRESS',
+	customer_mobile_number: 	'CUSTOMER MOBILE NUMBER',
+	customer_zip_code: 			'OPTIONAL, CUSTOMER ZIP CODE',
+	device_id: 					'APPLE DEVICE ID',
+	created_at: 				Time.zone.now
+}
+gsx.verify_order order_params
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/simple_gsx/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+Copyright (c) 2008-2014 zchar@mycolorway.com
+
+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/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/simple_gsx.rb

@@ -0,0 +1,171 @@
+require "simple_gsx/version"
+require "rest-client"
+require "json"
+
+module SimpleGsx
+  class Client
+    attr_reader :cert_file, :user_id, :password, :ship_to,
+      :cert_file, :lang_code, :time_zone
+
+    API_BASE = 'https://api-acc-ept.apple.com'
+    API_VERSION = '1.0'
+
+    AUTH_URL = "#{API_BASE}/authentication-service/#{API_VERSION}/authenticate/"
+
+    CREATE_ORDER_URL = "#{API_BASE}/order-service/#{API_VERSION}/create-order/"
+    CANCEL_ORDER_URL = "#{API_BASE}/order-service/#{API_VERSION}/cancel-order/"
+    VERIFY_ORDER_URL = "#{API_BASE}/order-service/#{API_VERSION}/verify-order/"
+    LOOKUP_URL = "#{API_BASE}/order-service/#{API_VERSION}/get-order/"
+
+    def initialize options
+      @user_id = options.fetch :user_id
+      @password = options.fetch :password
+      @ship_to = options.fetch :ship_to
+      @cert_file = options.fetch :cert_file
+
+      # Options
+      @lang_code = options[:lang_code] || 'zh'
+      @time_zone = options[:time_zone] || '-480'
+    end
+
+    #
+    # See: https://gsxwsut.apple.com/apidocs/acc/uat/html/WSReference.html?user=reseller
+    # Section: Order/CreateOrder
+    #
+    def create_order options
+      body = {
+        requestContext: request_context,
+        appleCareSalesDate: options[:purchase_date].strftime('%y-%m-%d'),
+        pocLanguage: 'ZHS',
+        pocDeliveryPreference: 'E',
+        purchaseOrderNumber: options[:purchase_order_number],
+        MRC: '',
+        marketID: '',
+        overridePocFlag: '',
+        emailFlag: 'Y',
+        customerRequest: customer_request(options),
+        deviceRequest: [device_request(options)]
+      }
+
+      api_request CREATE_ORDER_URL, body
+    end
+
+    #
+    # See: https://gsxwsut.apple.com/apidocs/acc/uat/html/WSReference.html?user=reseller
+    # Section: Order/CancelOrder
+    #
+    def cancel_order options
+      body = {
+        deviceId: options[:device_id],
+        purchaseOrderNumber: options[:purchase_order_number],
+        cancellationDate: options[:cancel_date].strftime('%y-%m-%d'),
+        cancelReasonCode: options[:cancel_reason_code] || "",
+        requestContext: request_context
+      }
+
+      api_request CANCEL_ORDER_URL, body
+    end
+
+    #
+    # See: https://gsxwsut.apple.com/apidocs/acc/uat/html/WSReference.html?user=reseller
+    # Section: Order/VerifyOrder
+    #
+    def verify_order options
+      body = {
+        requestContext: request_context,
+        appleCareSalesDate: "",
+        pocLanguage: "ZHS",
+        pocDeliveryPreference: "",
+        purchaseOrderNumber: "",
+        MRC: "",
+        marketID: "",
+        overridePocFlag: "",
+        emailFlag: "Y",
+        customerRequest: customer_request(options),
+        deviceRequest: [device_request(options)]
+      }
+
+      api_request VERIFY_ORDER_URL, body
+    end
+
+    #
+    # See: https://gsxwsut.apple.com/apidocs/acc/uat/html/WSReference.html?user=reseller
+    # Section: 360 Look Up
+    #
+    def order_lookup options
+      body = {
+        requestContext: request_context,
+        deviceId: options[:device_id],
+        purchaseOrderNumber: options[:purchase_order_number] || "",
+        customerEmailId: options[:customer_email_id] || ""
+      }
+
+      api_request LOOKUP_URL, body
+    end
+
+    private
+
+    def json json_string
+      JSON.parse json_string, symbolize_names: true
+    end
+
+    def headers
+      { accAccessToken: access_token, :'content-type' => 'application/json' }
+    end
+
+    def request_context
+      { shipTo: ship_to, timeZone: time_zone, langCode: lang_code }
+    end
+
+    def customer_request options
+      {
+        customerFirstName: options[:customer_first_name] || "",
+        customerLastName: options[:customer_last_name] || "",
+        companyName: "",
+        customerEmailId: options[:customer_email],
+        addressLine1: options[:customer_address],
+        addressLine2: "",
+        city: "",
+        stateCode: "230",
+        countryCode: "CN",
+        primaryPhoneNumber: options[:customer_mobile_number],
+        zipCode: options[:customer_zip_code]
+      }
+    end
+
+    def device_request options
+      {
+        deviceId: options[:device_id],
+        secondarySerialNumber: options[:secondary_device_id] || "",
+        hardwareDateOfPurchase: options[:date_of_purchase] || "" #"09/11/13"
+      }
+    end
+
+    def access_token
+      @access_token ||= begin
+                          body = {
+                            userId: user_id,
+                            password: password,
+                            shipTo: ship_to,
+                            langCode: lang_code,
+                            timeZone: time_zone
+                          }
+
+                          response = api_request AUTH_URL, body
+                          response[:accessToken]
+                        end
+    end
+
+    def api_request url, body
+      response = RestClient::Resource.new(
+        url,
+        :ssl_client_cert  =>  OpenSSL::X509::Certificate.new(File.read(cert_file)),
+        :ssl_client_key   =>  OpenSSL::PKey::RSA.new(File.read(cert_file), ''),
+        :ssl_ca_file      =>  cert_file,
+        :verify_ssl       =>  false
+      ).post JSON.dump(body), headers
+
+      json response
+    end
+  end
+end

data/lib/simple_gsx/version.rb

@@ -0,0 +1,3 @@
+module SimpleGsx
+  VERSION = "0.0.1"
+end

data/simple_gsx.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simple_gsx/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "simple_gsx"
+  spec.version       = SimpleGsx::VERSION
+  spec.authors       = ["zchar"]
+  spec.email         = ["zchar@mycolorway.com"]
+  spec.summary       = %q{Apple GSX API Library}
+  spec.description   = %q{A Ruby library for communicating with Apple's GSX restful API}
+  spec.homepage      = "https://github.com/mycolorway/simple_gsx"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 1.9.3'
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+
+  spec.add_dependency 'rest-client', '~> 1.6'
+  spec.add_dependency 'json', '~> 1.8'
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: simple_gsx
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- zchar
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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'
+- !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: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+description: A Ruby library for communicating with Apple's GSX restful API
+email:
+- zchar@mycolorway.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/simple_gsx.rb
+- lib/simple_gsx/version.rb
+- simple_gsx.gemspec
+homepage: https://github.com/mycolorway/simple_gsx
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Apple GSX API Library
+test_files: []