versacommerce_api 1.0.1

data/lib/versacommerce_api/resources/property.rb

@@ -0,0 +1,6 @@
+module VersacommerceAPI
+  
+  class Property < Base
+  end
+  
+end

data/lib/versacommerce_api/resources/shipment.rb

@@ -0,0 +1,11 @@
+module VersacommerceAPI
+
+  class Shipment < Base
+    include Associatable
+    
+    def order
+      associated_resource "order", false
+    end
+  end
+  
+end

data/lib/versacommerce_api/resources/shipping_addres.rb

@@ -0,0 +1,9 @@
+module VersacommerceAPI
+
+  class ShippingAddres < Base
+    def fullname
+      [firstname, lastname].delete_if(&:blank?).compact * " "
+    end
+  end
+  
+end

data/lib/versacommerce_api/resources/shop.rb

@@ -0,0 +1,10 @@
+module VersacommerceAPI
+
+  # Shop object. Use Shop.current to receive the shop.
+  class Shop < Base
+    def self.current
+      find(:one, :from => "/api/shop.xml")
+    end
+  end
+
+end

data/lib/versacommerce_api/resources/variant.rb

@@ -0,0 +1,7 @@
+module VersacommerceAPI
+  
+  class Variant < Base
+    self.prefix = "/api/products/:product_id/"
+  end
+  
+end

data/lib/versacommerce_api/session.rb

@@ -0,0 +1,88 @@
+module VersacommerceAPI
+
+  class Session
+    cattr_accessor :api_key
+    cattr_accessor :secret
+    cattr_accessor :protocol
+    self.protocol = 'http'
+
+    attr_accessor :url, :token, :name
+    
+
+    def initialize(url, token = nil, params = nil)
+      self.url, self.token = url, token
+      
+      if params && params[:signature]
+        unless self.class.validate_signature(params) && params[:timestamp].to_i > 24.hours.ago.utc.to_i
+          raise "Invalid Signature: Possible malicious login" 
+        end
+      end
+      
+      self.class.prepare_url(self.url)
+    end
+    
+
+    def self.setup(params)
+      params.each { |k,value| send("#{k}=", value) }
+    end
+
+
+    def self.request_token(domain)
+      return nil if domain.blank? || api_key.blank?
+      begin
+        content = open("http://#{domain}/api/auth.xml?api_key=#{api_key}") { |io| data = io.read }
+        Hash.from_xml(content)["token"] if content
+      rescue
+        nil
+      end
+    end
+
+
+    def shop
+      Shop.current
+    end
+    
+
+    def create_permission_url
+      return nil if url.blank? || api_key.blank?
+      "http://#{url}/api/auth?api_key=#{api_key}"
+    end
+
+
+    # Used by ActiveResource::Base to make all non-authentication API calls
+    def site
+      "#{protocol}://#{api_key}:#{computed_password}@#{url}/api/"
+    end
+    
+
+    def valid?
+      url.present? && token.present?
+    end
+
+    private
+
+    # The secret is computed by taking the shared_secret which we got when 
+    # registring this third party application and concating the request_to it, 
+    # and then calculating a MD5 hexdigest.
+    
+    # secret = shared_key
+    # token  was provided by registration
+    def computed_password
+      Digest::MD5.hexdigest(secret + token.to_s)
+    end
+    
+    def self.prepare_url(url)
+      return nil if url.blank?
+      url.gsub!(/https?:\/\//, '') # remove http:// or https://
+      url.concat(".versacommerce.de") unless url.include?('.')  # extend url to versacommerce.de if no host is given
+    end
+    
+    def self.validate_signature(params)
+      return false unless signature = params[:signature]
+
+      sorted_params = params.except(:signature, :action, :controller).collect{|k,v|"#{k}=#{v}"}.sort.join
+      Digest::MD5.hexdigest(secret + sorted_params) == signature
+    end
+  end
+  
+end

data/lib/versacommerce_api/version.rb

@@ -0,0 +1,3 @@
+module VersacommerceAPI
+  VERSION = "1.0.1"
+end

data/spec/resources/order_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+describe VersacommerceAPI::Order do
+  let!(:klass) { VersacommerceAPI::Order }
+
+  before(:all) do
+    initialize_session
+  end
+
+  describe 'CRUD Operations' do
+
+    describe 'Create' do
+      context 'New Order' do
+        context 'when order is valid' do
+          it 'should place a new order' do
+            order = klass.new(customer_email: 'dummy@email.de', item_total: 20)
+            order.save.should be_true
+          end
+        end
+
+        context 'when order is invalid' do
+          it 'should raise error'
+        end
+      end
+    end
+
+    describe 'Retrive' do
+      context 'when order does not exist' do
+        it 'should raise resource not found error' do
+          expect { klass.find(23456789) }.to raise_error(ActiveResource::ResourceNotFound)
+        end
+      end
+
+      context 'when order exist' do
+        it 'should return the order' do
+          orders = klass.find(:all, :params => {:limit => 2})
+          orders.count.should eql 2
+        end
+      end
+    end
+
+    describe 'Update' do
+      context 'for existing order' do
+        it 'should update the attributes of the order' do
+          order = klass.last
+          order.update_attribute(:bank_account_name, 'German Bank')
+          klass.find(order.id).bank_account_name.should eql 'German Bank'
+        end
+      end
+    end
+
+    describe 'delete' do
+      before(:all) { @order = VersacommerceAPI::Order.last }
+
+      context 'when order exist' do
+        it 'should delete the order' do
+          response = @order.destroy
+          response.code.should eql '200'
+        end
+      end
+
+      context 'when order does not exist' do
+        it 'should raise error' do
+          response = @order.destroy
+          response.code.should eql '404'
+        end
+      end
+    end
+  end
+
+end

data/spec/resources/product_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+describe VersacommerceAPI::Product do
+  let!(:klass) { VersacommerceAPI::Product }
+
+  before(:all) do
+    initialize_session
+  end
+
+  describe 'CRUD Operations' do
+
+    describe 'Create' do
+      context 'new product' do
+        context 'when invalid' do
+          it 'should contains error messages' do
+            new_product = klass.create(:title => 'New-Api-product')
+            expect { new_product.errors.messages[:base].present? }.to be_true
+          end
+        end
+
+        context 'when valid' do
+          it 'should save the product' do
+            new_product = klass.new(:title => 'New-Api-product', :code=>"1x Api Product")
+            new_product.save.should be_true
+          end
+        end
+      end
+    end
+
+    describe "Retrive" do
+      context "when product not found" do
+        it 'should raise resource not found error' do
+          expect { klass.find(23456789) }.to raise_error(ActiveResource::ResourceNotFound)
+        end
+      end
+
+      context "when fetching products with limit value" do
+        it 'should return specified number of products' do
+          products = klass.find(:all, :params => {:limit => 2})
+          products.count.should eql 2
+        end
+      end
+    end
+
+    describe 'Update' do
+      context 'for an existing product' do
+        it 'should update the given product attributes' do
+         product = klass.where(code: "1x Api Product").first
+         product.code = '2x Api Product'
+         product.save!
+         expect { klass.find(product.id).code }.should eql '2x Api Product'
+        end
+      end
+    end
+
+    describe 'Delete' do
+      before(:all) { @product = VersacommerceAPI::Product.last }
+
+      context 'when product exist' do
+        it 'should delete the specified product' do
+          response = @product.destroy
+          response.code.should eql '200'
+        end
+      end
+
+      context 'when product does not exist' do
+        it 'should raise resource not found errors' do
+          expect { klass.find(23456789) }.to raise_error(ActiveResource::ResourceNotFound)
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'rspec'
+require 'pry'
+
+require './lib/versacommerce_api/'
+
+RSpec.configure do |c|
+	c.mock_with :rspec
+end
+
+
+def initialize_session
+	VersacommerceAPI::Session.setup(api_key: "4e6d0a2be244cff731f88caaff45e6ea3d2f9221", secret: "afe883e32194fc464c029e73fe9f3674b6e4996e")
+	token = "c26a0c74" #VersacommerceAPI::Session.request_token("test-produkte.versacommerce.de")
+	session = VersacommerceAPI::Session.new("test-produkte.versacommerce.de", token)
+	VersacommerceAPI::Base.activate_session(session)
+end

data/versacommerce_api.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'versacommerce_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "versacommerce_api"
+  spec.version       = VersacommerceAPI::VERSION
+  spec.author        = ["VersaCommerce"]
+
+  spec.summary          = %q{The VersaCommerce API gem is a lightweight gem for accessing the VersaCommerce admin REST web services}
+  spec.description      = %q{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.}
+  spec.homepage      = "http://www.versacommerce.de"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-nav"
+
+  spec.add_dependency("activeresource", "~> 3.2.14")
+  spec.add_dependency("thor", [">= 0.14.4"])
+
+  if spec.respond_to?(:add_development_dependency)
+    spec.add_development_dependency("mocha", ">= 0.9.8")
+    spec.add_development_dependency("fakeweb")
+  else
+    spec.add_dependency("mocha", ">= 0.9.8")
+    spec.add_dependency("fakeweb")
+  end
+end

metadata

@@ -0,0 +1,242 @@
+--- !ruby/object:Gem::Specification
+name: versacommerce_api
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+  prerelease: 
+platform: ruby
+authors:
+- VersaCommerce
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activeresource
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.14
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.14
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.14.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.14.4
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.8
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 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.
+email: 
+executables:
+- versacommerce
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-version
+- CHANGELOG
+- CONTRIBUTORS
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- RELEASING
+- Rakefile
+- bin/versacommerce
+- lib/active_resource/base_ext.rb
+- lib/active_resource/connection_ext.rb
+- lib/active_resource/detailed_log_subscriber.rb
+- lib/active_resource/disable_prefix_check.rb
+- lib/active_resource/json_errors.rb
+- lib/versacommerce_api.rb
+- lib/versacommerce_api/associatable.rb
+- lib/versacommerce_api/cli.rb
+- lib/versacommerce_api/countable.rb
+- lib/versacommerce_api/resources.rb
+- lib/versacommerce_api/resources/base.rb
+- lib/versacommerce_api/resources/billing_addres.rb
+- lib/versacommerce_api/resources/collection.rb
+- lib/versacommerce_api/resources/customer.rb
+- lib/versacommerce_api/resources/item.rb
+- lib/versacommerce_api/resources/link.rb
+- lib/versacommerce_api/resources/linklist.rb
+- lib/versacommerce_api/resources/order.rb
+- lib/versacommerce_api/resources/page.rb
+- lib/versacommerce_api/resources/payment.rb
+- lib/versacommerce_api/resources/product.rb
+- lib/versacommerce_api/resources/product_image.rb
+- lib/versacommerce_api/resources/property.rb
+- lib/versacommerce_api/resources/shipment.rb
+- lib/versacommerce_api/resources/shipping_addres.rb
+- lib/versacommerce_api/resources/shop.rb
+- lib/versacommerce_api/resources/variant.rb
+- lib/versacommerce_api/session.rb
+- lib/versacommerce_api/version.rb
+- spec/resources/order_spec.rb
+- spec/resources/product_spec.rb
+- spec/spec_helper.rb
+- versacommerce_api.gemspec
+homepage: http://www.versacommerce.de
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: The VersaCommerce API gem is a lightweight gem for accessing the VersaCommerce
+  admin REST web services
+test_files:
+- spec/resources/order_spec.rb
+- spec/resources/product_spec.rb
+- spec/spec_helper.rb
+has_rdoc: