shopkit 0.1.3 → 0.1.4

data/README.md

@@ -1,19 +1,55 @@
-= Shopkit
+# Shopkit
 
-Description goes here.
+ShopQi Ruby API 客户端
 
-== Contributing to Shopkit
- 
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
-* Fork the project.
-* Start a feature/bugfix branch.
-* Commit and push until you are happy with your contribution.
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+## 安装
 
-== Copyright
+$ gem install shopkit
 
-Copyright (c) 2012 saberma. See LICENSE.txt for
-further details.
+## 使用
 
+* 通过 api clients 访问
+
+    require 'shopkit'
+    Shopkit.setup url: 'https://your-shop-name.shopqi.com', login: 'api key', password: 'password'
+    Shopkit.orders # 获取订单
+
+`api key`, `password` 在商店后台管理 [应用] - [私有应用]，点击"生成新的应用"即可看到
+
+* 通过 OAuth2 访问
+
+    require 'shopkit'
+    Shopkit.setup url: 'https://rubyconfchina-shop.shopqi.com', access_token: 'access token'
+    Shopkit.products # 获取商品
+
+`access token`为商店授权给应用后获取
+
+## API
+
+### 商店
+
+[商店属性](https://github.com/saberma/shopqi/blob/master/app/views/api/v1/shops/show.rabl)
+
+### 订单
+
+[订单属性](https://github.com/saberma/shopqi/blob/master/app/views/api/v1/orders/show.rabl)
+[订单商品](https://github.com/saberma/shopqi/blob/master/app/views/api/v1/orders/line_items/show.rabl)
+
+### 商品
+
+[商品属性](https://github.com/saberma/shopqi/blob/master/app/views/api/v1/products/show.rabl)
+[商品款式](https://github.com/saberma/shopqi/blob/master/app/views/api/v1/product_variants/show.rabl)
+
+## 开发
+
+### 发布
+
+修改 `lib/shopkit/version.rb`
+
+    rake release -t -v
+
+如果出现以下问题
+
+    ERROR:  Using beta/unreleased version of rubygems. Not pushing
+
+请尝试使用 VPN 连接网络，推荐 vpncup(免费)

data/lib/shopkit.rb

@@ -10,6 +10,8 @@ module Shopkit
     def new(options={})
       options['url'] = self.url
       options['access_token'] = self.access_token
+      options['login'] = self.login
+      options['password'] = self.password
       Shopkit::Client.new(options)
     end
 
@@ -22,7 +24,10 @@ module Shopkit
 
     def setup(options)
       self.url = options[:url]
+      self.url = "http://#{self.url}" unless self.url.start_with?('http://', 'https://')
       self.access_token = options[:access_token]
+      self.login = options[:login] # or basic auth
+      self.password = options[:password]
       options
     end
 

data/lib/shopkit/client.rb

@@ -1,5 +1,6 @@
 require 'shopkit/connection'
 require 'shopkit/request'
+require 'shopkit/traversal'
 
 #Load all files in client/ directory
 Dir.glob("#{File.expand_path(File.dirname(__FILE__))}/client/*.rb").sort.each do |f|
@@ -19,5 +20,6 @@ module Shopkit
 
     include Shopkit::Connection
     include Shopkit::Request
+    include Shopkit::Traversal
   end
 end

data/lib/shopkit/client/orders.rb

@@ -3,7 +3,9 @@ module Shopkit
     module Orders
 
       def orders(options={})
-        get('/orders', options)['orders']
+        traversal(options) do
+          get('/orders', options)['orders']
+        end
       end
 
       def order(id, options={})

data/lib/shopkit/client/products.rb

@@ -6,6 +6,10 @@ module Shopkit
         get('/products', options)['products']
       end
 
+      def product(id, options={})
+        get("/products/#{id}", options)['product']
+      end
+
     end
 
     include Products

data/lib/shopkit/configuration.rb

@@ -8,6 +8,8 @@ module Shopkit
       :api_version,
       :url,
       :access_token,
+      :login,
+      :password,
       :user_agent,
       :auto_traversal,
       :per_page].freeze
@@ -34,7 +36,9 @@ module Shopkit
     def reset
       self.adapter        = DEFAULT_ADAPTER
       self.api_version    = DEFAULT_API_VERSION
-      self.access_token    = nil
+      self.access_token   = nil
+      self.login          = nil
+      self.password       = nil
       self.user_agent     = DEFAULT_USER_AGENT
       self.auto_traversal = DEFAULT_AUTO_TRAVERSAL
     end

data/lib/shopkit/connection.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 require 'faraday_middleware'
 require 'faraday_middleware/request/oauth2'
 
@@ -7,16 +8,17 @@ module Shopkit
     private
 
     def connection
-      #@conn ||= Faraday.new(:url => "https://#{url}") do |builder|
-      @conn ||= Faraday.new(:url => "http://#{url}") do |builder|
-        builder.request :oauth2, access_token
+      @conn ||= Faraday.new(:url => url) do |builder|
+        builder.request :oauth2, access_token if access_token
+        builder.request :basic_auth, login, password if login and password
         builder.request :json # fixed: NoMethodError: undefined method `bytesize' for {...}:Hash
 
-        #builder.response :logger
+        #builder.response :logger # 调试
         builder.response :json, :content_type => /\bjson$/
 
         builder.adapter :net_http
       end
+      @conn
     end
 
   end

data/lib/shopkit/request.rb

@@ -31,6 +31,7 @@ module Shopkit
         end
       end
 
+
       response.body
     end
 

data/lib/shopkit/traversal.rb

@@ -0,0 +1,17 @@
+module Shopkit
+  module Traversal
+
+    def traversal(options) # 遍历所有页面
+      list = yield(options)
+      if auto_traversal and !list.empty?
+        options[:page] ||= 1
+        options[:page] += 1
+        list += traversal(options) do
+          yield(options)
+        end
+      end
+      list
+    end
+
+  end
+end

data/lib/shopkit/version.rb

@@ -1,3 +1,3 @@
 module Shopkit
-  VERSION = "0.1.3" unless defined?(Shopkit::VERSION)
+  VERSION = "0.1.4" unless defined?(Shopkit::VERSION)
 end

data/shopkit.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "shopkit"
-  s.version = "0.1.3"
+  s.version = "0.1.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["saberma"]
-  s.date = "2012-08-01"
+  s.date = "2012-10-04"
   s.description = "a gem for the ShopQi API"
   s.email = "mahb45@gmail.com"
   s.extra_rdoc_files = [
@@ -35,10 +35,15 @@ Gem::Specification.new do |s|
     "lib/shopkit/configuration.rb",
     "lib/shopkit/connection.rb",
     "lib/shopkit/request.rb",
+    "lib/shopkit/traversal.rb",
     "lib/shopkit/version.rb",
     "shopkit.gemspec",
     "spec/json/order.json",
     "spec/json/orders.json",
+    "spec/json/orders_empty.json",
+    "spec/json/orders_page_2.json",
+    "spec/json/orders_page_3.json",
+    "spec/json/product.json",
     "spec/json/products.json",
     "spec/json/shop.json",
     "spec/json/variant.json",
@@ -48,6 +53,7 @@ Gem::Specification.new do |s|
     "spec/shopkit/client/products_spec.rb",
     "spec/shopkit/client/shop_spec.rb",
     "spec/shopkit/client/webhooks_spec.rb",
+    "spec/shopkit/shopkit_spec.rb",
     "spec/spec_helper.rb"
   ]
   s.homepage = "http://github.com/saberma/shopkit"

data/spec/json/orders_empty.json

@@ -0,0 +1,3 @@
+{
+  "orders": []
+}

data/spec/json/orders_page_2.json

@@ -0,0 +1,29 @@
+{
+  "orders": [
+    {
+      "cancel_reason": null,
+      "cancelled_at": null,
+      "closed_at": "2012-05-15T21:36:38+08:00",
+      "created_at": "2012-04-16T23:07:33+08:00",
+      "customer_id": 2,
+      "email": "mahb45@gmail.com",
+      "financial_status": "pending",
+      "fulfillment_status": "fulfilled",
+      "id": 100,
+      "name": "#1096",
+      "note": "",
+      "number": 96,
+      "order_number": 1096,
+      "payment_id": 8,
+      "shipping_rate": "普通快递-0",
+      "shop_id": 2,
+      "status": "closed",
+      "subtotal_price": 45.0,
+      "token": "96b1d0806s0d928f21f6480aa969d9a6",
+      "total_line_items_price": 45.0,
+      "total_price": 45.0,
+      "trade_no": null,
+      "updated_at": "2012-05-15T21:36:38+08:00"
+    }
+  ]
+}

data/spec/json/orders_page_3.json

@@ -0,0 +1,29 @@
+{
+  "orders": [
+    {
+      "cancel_reason": null,
+      "cancelled_at": null,
+      "closed_at": "2012-05-15T21:36:38+08:00",
+      "created_at": "2012-04-16T23:07:33+08:00",
+      "customer_id": 2,
+      "email": "mahb45@gmail.com",
+      "financial_status": "pending",
+      "fulfillment_status": "fulfilled",
+      "id": 101,
+      "name": "#1097",
+      "note": "",
+      "number": 97,
+      "order_number": 1097,
+      "payment_id": 8,
+      "shipping_rate": "普通快递-0",
+      "shop_id": 2,
+      "status": "closed",
+      "subtotal_price": 45.0,
+      "token": "96b1d0806s0d928f21f6480aa969d9a6",
+      "total_line_items_price": 45.0,
+      "total_price": 45.0,
+      "trade_no": null,
+      "updated_at": "2012-05-15T21:36:38+08:00"
+    }
+  ]
+}

data/spec/json/product.json

@@ -0,0 +1,76 @@
+{
+  "product": {
+    "body_html": "",
+    "created_at": "2012-01-14T11:02:58+08:00",
+    "handle": "tee-01",
+    "id": 138,
+    "price": 45.0,
+    "product_type": "T恤",
+    "published": true,
+    "shop_id": 2,
+    "title": "Tee 01",
+    "updated_at": "2012-05-21T18:49:13+08:00",
+    "vendor": "吉尔丹",
+    "variants": [
+      {
+        "compare_at_price": null,
+        "created_at": "2012-03-26T21:45:47+08:00",
+        "id": 169,
+        "inventory_management": "",
+        "inventory_policy": "deny",
+        "inventory_quantity": null,
+        "option1": "默认大小",
+        "option2": "1",
+        "option3": "M",
+        "position": 1,
+        "price": 1900.0,
+        "product_id": 138,
+        "requires_shipping": true,
+        "shop_id": 2,
+        "sku": "",
+        "updated_at": "2012-05-21T21:24:58+08:00",
+        "weight": 0.0
+      },
+      {
+        "compare_at_price": null,
+        "created_at": "2012-05-21T18:49:53+08:00",
+        "id": 177,
+        "inventory_management": "",
+        "inventory_policy": "deny",
+        "inventory_quantity": null,
+        "option1": "默认",
+        "option2": "3",
+        "option3": "XL",
+        "position": 2,
+        "price": 1900.0,
+        "product_id": 138,
+        "requires_shipping": true,
+        "shop_id": 2,
+        "sku": "",
+        "updated_at": "2012-05-21T21:24:58+08:00",
+        "weight": 0.0
+      }
+    ],
+    "photos": [
+      {
+        "created_at": "2012-03-23T11:24:42+08:00",
+        "id": 154,
+        "position": 0,
+        "product_id": 138,
+        "product_image_format": "jpg",
+        "product_image_uid": "2/products/138/pink-preview_810.jpg",
+        "updated_at": "2012-03-23T11:24:54+08:00"
+      }
+    ],
+    "options": [
+      {
+        "name": "标题",
+        "position": 1
+      },
+      {
+        "name": "大小",
+        "position": 2
+      }
+    ]
+  }
+}

data/spec/shopkit/client/products_spec.rb

@@ -9,5 +9,11 @@ describe Shopkit::Client::Products do
   it 'should get products' do
     Shopkit.products.size.should_not eql 0
   end
+
+  it 'should get product' do
+    id = 138
+    fake_web "products/#{id}", json_file: :product
+    Shopkit.product(id)['id'].should eql id
+  end
   
 end

data/spec/shopkit/shopkit_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe Shopkit do
+
+  before do
+    fake_web "orders", query: {per_page: 1, page: 1}
+    fake_web "orders", query: {per_page: 1, page: 2}, json_file: "orders_page_2"
+    fake_web "orders", query: {per_page: 1, page: 3}, json_file: "orders_page_3"
+    fake_web "orders", query: {per_page: 1, page: 4}, json_file: "orders_empty"
+    Shopkit.auto_traversal = true
+  end
+
+  after do
+    Shopkit.auto_traversal = false
+  end
+
+  it 'should be auto_traversal' do
+    Shopkit.orders(per_page: 1, page: 1).size.should eql 3
+  end
+  
+end

data/spec/spec_helper.rb

@@ -5,7 +5,8 @@ require 'webmock/rspec'
 RSpec.configure do |config|
 
   config.before(:each) do
-    shop_url = 'ruby-china-shop.shopqi.com'
+    #shop_url = 'https://ruby-china-shop.shopqi.com'
+    shop_url = 'http://ruby-china-shop.shopqi.com'
     access_token = 'b68da7c5eb6c07ff3f5a1ce731555fdc'
 
     Shopkit.setup(url: shop_url, access_token: access_token)
@@ -21,9 +22,10 @@ RSpec.configure do |config|
     body = options.has_key?(:body) ? options.delete(:body) : load_json(file)
     method = options.delete(:method) || :get
 
-    #url = "https://#{Shopkit.url}/api/#{endpoint}.json"
-    url = "http://#{Shopkit.url}/api/#{endpoint}.json"
-    stub_request(method, url).with(body: request_body).to_return(body: body, headers: { content_type: 'text/json' })
+    url = "#{Shopkit.url}/api/#{endpoint}.json"
+    params = {body: request_body}
+    params.merge! query: options[:query] if options[:query]
+    stub_request(method, url).with(params).to_return(body: body, headers: { content_type: 'text/json' })
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shopkit
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-01 00:00:00.000000000 Z
+date: 2012-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -165,10 +165,15 @@ files:
 - lib/shopkit/configuration.rb
 - lib/shopkit/connection.rb
 - lib/shopkit/request.rb
+- lib/shopkit/traversal.rb
 - lib/shopkit/version.rb
 - shopkit.gemspec
 - spec/json/order.json
 - spec/json/orders.json
+- spec/json/orders_empty.json
+- spec/json/orders_page_2.json
+- spec/json/orders_page_3.json
+- spec/json/product.json
 - spec/json/products.json
 - spec/json/shop.json
 - spec/json/variant.json
@@ -178,6 +183,7 @@ files:
 - spec/shopkit/client/products_spec.rb
 - spec/shopkit/client/shop_spec.rb
 - spec/shopkit/client/webhooks_spec.rb
+- spec/shopkit/shopkit_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/saberma/shopkit
 licenses:
@@ -194,7 +200,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 701946319
+      hash: 474065761
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: