versacommerce_api 1.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.rbc
+*.sassc
+.sass-cache
+capybara-*.html
+.rspec
+/.bundle
+/vendor/bundle
+/log/*
+/tmp/*
+/db/*.sqlite3
+/public/system/*
+/coverage/
+/spec/tmp/*
+**.orig
+rerun.txt
+pickle-email-*.html
+.DS_Store
+/scratchpads

data/.ruby-version

@@ -0,0 +1 @@
+1.9.3-p429

data/CHANGELOG

@@ -0,0 +1,2 @@
+
+1.0.1 - First public release

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,59 @@
+PATH
+  remote: .
+  specs:
+    versacommerce_api (1.0.1)
+      activeresource (~> 3.2.14)
+      thor (>= 0.14.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (3.2.14)
+      activesupport (= 3.2.14)
+      builder (~> 3.0.0)
+    activeresource (3.2.14)
+      activemodel (= 3.2.14)
+      activesupport (= 3.2.14)
+    activesupport (3.2.14)
+      i18n (~> 0.6, >= 0.6.4)
+      multi_json (~> 1.0)
+    builder (3.0.4)
+    coderay (1.0.9)
+    diff-lcs (1.2.4)
+    fakeweb (1.3.0)
+    i18n (0.6.5)
+    metaclass (0.0.1)
+    method_source (0.8.2)
+    mocha (0.14.0)
+      metaclass (~> 0.0.1)
+    multi_json (1.8.0)
+    pry (0.9.12.2)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    pry-nav (0.2.3)
+      pry (~> 0.9.10)
+    rake (10.1.0)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.5)
+    rspec-expectations (2.14.3)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.3)
+    slop (3.4.6)
+    thor (0.18.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  fakeweb
+  mocha (>= 0.9.8)
+  pry
+  pry-nav
+  rake
+  rspec
+  versacommerce_api!

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Bjoern B. Dorra
+
+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,200 @@
+# VersacommerceAPI
+
+The VersaCommerce API gem allows Ruby developers to programmatically access the admin section of VersaCommerce shops. The API is implemented as JSON or XML over HTTP using all four verbs (GET/POST/PUT/DELETE). Each resource, like Order, Product, or Collection, has its own URL and is manipulated in isolation.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'versacommerce_api'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install versacommerce_api
+
+## Introduction
+
+Every app needs to:
+
+1. Registered with VersaCommerce. You will receive an APP_KEY and a shared secret.
+2. Registered with a Shop. This will provide a token.
+
+You communicate with your shop using your APP_KEY and a generated password. The password is an MD5-Hash of your token and shared secret.
+
+
+For detailed information see: [Authentication](https://github.com/versacommerce/vc-api/blob/master/sections/authentication.md)
+
+
+## Registering your app with a shop.
+
+    $ open http://YOUR-VERSACOMMERCE-DOMAIN.versacommerce.de/api/auth?api_key=API_KEY
+
+## Interactive console
+
+    You need you API-KEY and generated password. (http://YOUR-VERSACOMMERCE-DOMAIN.versacommerce.de/admin/settings/apps)
+
+    $ bin/versacommerce add YOUR-VERSACOMMERCE-DOMAIN (enter APP-Key and password)
+    $ bin/versacommerce console
+    irb(main):001:0> VersacommerceAPI::Shop.current
+
+## Sample code:
+
+    require "rubygems"
+    require "versacommerce_api"
+
+    # instantiate a session that is ready to make calls to the given shop.
+    VersacommerceAPI::Session.setup(api_key: "API_KEY_FOR_APP", secret: "SHARED_SECRET_FOR_APP")
+    
+    # If your app is resistered with you shop, you can request the "registration-token" 
+    token    = VersacommerceAPI::Session.request_token("api-test.versacommerce.de")
+    
+    # Instantiate a session that is ready to make calls to the given shop.
+    session  = VersacommerceAPI::Session.new("shopdomain.versacommerce.de", "RECEIVED_TOKEN")
+    session.valid?  # returns true
+    
+    # Now you can activate the session and you’re set:
+    VersacommerceAPI::Base.activate_session(session)
+
+    # Get data from that shop (returns ActiveResource instances):
+    shop = VersacommerceAPI::Shop.current
+    
+    # Get three products:
+    products = VersacommerceAPI::Product.find(:all, :params => {:limit => 3})
+    
+    # Get some orders:
+    latest_orders = VersacommerceAPI::Order.find(:all)
+    
+### Product
+
+
+Get product count:
+
+    VersacommerceAPI::Product.count
+    => 18
+    
+Get product count including variants:
+
+    VersacommerceAPI::Product.count("show_variants" => "true")
+    => 21
+
+Find all products:
+
+    VersacommerceAPI::Product.find(:all, params: {limit: 3})
+
+Find all products and variants (nested objects):
+
+    VersacommerceAPI::Product.find(:all, params: {include: :variants})
+
+Find all products and variants (not nested):
+
+    VersacommerceAPI::Product.find(:all, params: {show_variants: true})
+    
+Fetch a product and the nested variants:
+
+    VersacommerceAPI::Product.find(167357, params: {include: :variants})
+    
+Fetch a product and nested properties of that product:
+
+    VersacommerceAPI::Product.find(167357, params: {include: :variants})
+
+Fetch a product and the nested variants including properties of those products and variants:
+
+    VersacommerceAPI::Product.find(167357, params: {include: [:variants, :properties]})
+
+*Reference:*
+
+* [Product](https://github.com/versacommerce/vc-api/blob/master/sections/product.md)
+* [ProductImage](https://github.com/versacommerce/vc-api/blob/master/sections/product_image.md)
+* [Variant](https://github.com/versacommerce/vc-api/blob/master/sections/variant.md)
+* [Property](https://github.com/versacommerce/vc-api/blob/master/sections/property.md)
+
+#### Receive products in batches
+
+You can receive max 250 records per request. The default limit is 150. If you need to handle more records, you should request them in batches. Use the query params "limit" and "offset" to batch through your results.
+
+Sample, receive all products and prints them.
+
+      require "rubygems"
+      require "versacommerce_api"
+
+      products       = []
+      products_count = VersacommerceAPI::Product.count("show_variants" => "true")
+      num_batches    = (products_count.to_f / 200).ceil
+      num_batches.times do |batch|
+        puts  "Fetching products: Batch #{batch+1} of #{num_batches}"
+        products.concat VersacommerceAPI::Product.find(:all, params: {limit: 200, offset: batch*200, show_variants: true})
+      end
+      
+      products.each do |product|
+        puts "product code : #{product.code}"
+        puts "product title: #{product.title}"
+      end
+
+### Order
+
+    VersacommerceAPI::Order.find(:all, :params => {:limit => 3})
+
+*Reference:*
+
+* [Order](https://github.com/versacommerce/vc-api/blob/master/sections/order.md)
+* [Item](https://github.com/versacommerce/vc-api/blob/master/sections/item.md)
+* [Customer](https://github.com/versacommerce/bcx-api/blob/master/sections/custimer.md)
+* [BillingAddress](https://github.com/versacommerce/bcx-api/blob/master/sections/billing_address.md)
+* [ShippingAddress](https://github.com/versacommerce/vc-api/blob/master/sections/shipping_address.md)
+* [Shipment](https://github.com/versacommerce/vc-api/blob/master/sections/shipment.md)
+* [Payment](https://github.com/versacommerce/vc-api/blob/master/sections/payment.md)
+
+### Customer
+
+    VersacommerceAPI::Customer.find(:all, :params => {:limit => 3, :include => :billing_address})
+    c = VersacommerceAPI::Customer.find(18451)
+    c.option_01 = "test"
+    c.save
+
+### Page
+
+    VersacommerceAPI::Page.find(:all).first
+
+    => {
+      "active"=>true,
+      "title"=>"AGB",
+      "content"=>"<p>This is some Text</p>",
+      "content_meta_description"=>"This is a special page.",
+      "content_meta_keywords"=>"kewords, supported",
+      "content_title_tag"=>"Search engine optimized title",
+      "custom_url"=>nil,
+      "custom_url_routing"=>"standard_url_is_canonical",
+      "format"=>"tinymce",
+      "handle"=>"this-is-a-special-page",
+      "id"=>9070,
+      "option_01"=>nil,
+      "option_02"=>nil,
+      "option_03"=>nil,
+      "properties_count"=>0,
+      "mall_id"=>nil,
+      "shop_id"=>1157,
+      "created_on"=>Mon, 10 Sep 2013,
+      "updated_on"=>Mon, 10 Sep 2013
+      }
+
+*Reference:*
+
+* [Page](https://github.com/versacommerce/vc-api/blob/master/sections/page.md)
+
+## TODO
+
+* Add more resources
+* More documentation
+* More Specs
+
+## Contributing
+
+1. Fork it
+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

data/RELEASING

@@ -0,0 +1,16 @@
+Releasing VersacommerceAPI
+
+1. Check the Semantic Versioning page for info on how to version the new release: http://semver.org
+2. Update the version of VersacommerceAPI in lib/versacommerce_api/version.rb
+3. Add a CHANGELOG entry for the new release with the date
+4. Commit the changes with a commit message like "Packaging for release X.Y.Z"
+5. Tag the release with the version (Leave REV blank for HEAD or provide a SHA)
+  $ git tag vX.Y.Z REV
+6. Push out the changes
+  $ git push
+7. Push out the tags
+  $ git push --tags
+8. Build the new .gem from the updated .gemspec
+  $ gem build versacommerce_api.gemspec
+9. Publish the Gem to gemcutter
+  $ gem push versacommerce_api-X.Y.Z.gem

data/Rakefile

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

data/bin/versacommerce

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require File.expand_path('../../lib/versacommerce_api',__FILE__)
+require File.expand_path('../../lib/versacommerce_api/cli',__FILE__)
+VersacommerceAPI::Cli.start(ARGV)

data/lib/active_resource/base_ext.rb

@@ -0,0 +1,22 @@
+module ActiveResource
+  class Base
+    # Backported from ActiveResource master branch
+    def self.headers
+      @headers ||= {}
+
+      if superclass != Object && superclass.headers
+        @headers = superclass.headers.merge(@headers)
+      else
+        @headers
+      end
+    end
+    # https://github.com/rails/activeresource/commit/dfef85ce8f653f75673631b2950fcdb0781c313c
+    def self.delete(id, options = {})
+      connection.delete(element_path(id, options), headers)
+    end
+    def self.build(attributes = {})
+      attrs = self.format.decode(connection.get("#{new_element_path}", headers).body).merge(attributes)
+      self.new(attrs)
+    end
+  end
+end

data/lib/active_resource/connection_ext.rb

@@ -0,0 +1,31 @@
+require 'active_support/core_ext/module/aliasing'
+
+module ActiveResource
+  class Connection
+
+    attr_reader :response
+
+    def handle_response_with_response_capture(response)
+      @response = handle_response_without_response_capture(response)
+    end
+
+    def request_with_detailed_log_subscriber(method, path, *arguments)
+      result = request_without_detailed_log_subscriber(method, path, *arguments)
+      detailed_log_subscriber(result, arguments)
+      result
+    rescue => e
+      detailed_log_subscriber(e.response, arguments) if e.respond_to?(:response)
+      raise
+    end
+
+    def detailed_log_subscriber(response, arguments)
+      ActiveSupport::Notifications.instrument("request.active_resource_detailed") do |payload|
+        payload[:response] = response
+        payload[:data]     = arguments
+      end
+    end
+
+    alias_method_chain :handle_response, :response_capture
+    alias_method_chain :request, :detailed_log_subscriber
+  end
+end

data/lib/active_resource/detailed_log_subscriber.rb

@@ -0,0 +1,19 @@
+module ActiveResource
+  class DetailedLogSubscriber < ActiveSupport::LogSubscriber
+    def request(event)
+      data = event.payload[:data]
+      headers = data.extract_options!
+      request_body = data.first
+
+      info "Request:\n#{request_body}" if request_body
+      info "Headers: #{headers.inspect}"
+      info "Response:\n#{event.payload[:response].body}"
+    end
+
+    def logger
+      ActiveResource::Base.logger
+    end
+  end
+end
+
+ActiveResource::DetailedLogSubscriber.attach_to :active_resource_detailed

data/lib/active_resource/disable_prefix_check.rb

@@ -0,0 +1,8 @@
+module DisablePrefixCheck
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    def check_prefix_options(options)
+    end
+  end
+end

data/lib/active_resource/json_errors.rb

@@ -0,0 +1,21 @@
+require 'active_resource/base'
+
+module ActiveResource
+  class Errors < ActiveModel::Errors
+    def from_hash(messages, save_cache = false)
+      clear unless save_cache
+
+      messages.each do |key,errors|
+        errors.each do |error|
+          add(key, error)
+        end
+      end
+    end
+
+    # Grabs errors from a json response.
+    def from_json(json, save_cache = false)
+      hash = ActiveSupport::JSON.decode(json)['errors'] || {} rescue {}
+      from_hash hash, save_cache
+    end
+  end
+end