zookal_magento_rest_api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bf6d8162f9afab5ccd2ded8c08185cb69f4947bc
+  data.tar.gz: 138417e1bf08fbfda6f85fbeac1f2eba8d7a4052
+SHA512:
+  metadata.gz: 2c0443d11fac83e0af948f798c28466468a6f42f56891ec3589aa0b61525f5a46030bc23d433c46404f3e2d1399cff4c942c5db0271873ef9fb45fdd8c22dc7c
+  data.tar.gz: 913e5ab08f2a9c5e94ef11da5ffd0b514a8f988c9867de497b1d8484f8ea207fee42e0371b61e0b0e1c2c2b27283b76d1ad9bd0bd31fd9b6fd2ac0e5cb677ebb

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Michael Imstepf
+
+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,82 @@
+# ZookalMagentoRestApi
+
+Ruby wrapper for backend calls to Zookal's Magento store. Prior authentication & authorization (through oAuth) required.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'zookal_magento_rest_api'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install zookal_magento_rest_api
+
+## Setup
+
+Create a file `config/initializers/zookal_magento_rest_api.rb` with the following content and restart Rails after saving the file:
+
+    ZookalMagentoRestApi.configure do |config|
+      config.consumer_key = "123dsfdsafQ231"                                                             # from Magento Admin panel
+      config.consumer_secret = "23dfsfFdsfsdee"                                                          # from Magento Admin panel
+      config.site = "https://www.zookal.com"                                                             # without trailing slash and no redirects (e.g. root domain to www)
+      config.access_key = "3434412373rf"                                                                 # from prior authentication
+      config.access_secret = "df23sdfsf23a"                                                              # from prior authentication
+      config.url_params = "utm_source=some-company&utm_medium=affiliate&utm_campaign=newsletter-01-2014" # optional
+    end
+
+*Important*: Make sure the URL in the site configuration is without trailing slash and has no redirect (e.g. `https://zookal.com` redirects to `https://www.zookal.com`). Otherwise you'll get a 301 Redirect error for each request.
+
+Information on how to obtain access_key and access_secret can be seen [here](https://github.com/necrodome/magento-rails-rest-access-sample/blob/master/app/controllers/products_controller.rb)
+
+## Usage
+
+Instantiate a client
+
+    zookal_magento_client = ZookalMagentoRestApi::Client.new
+
+Query a book
+
+    book_buy_new = zookal_magento_client.find_by(isbn: 9781442531109, purchase_type: "Buy New")
+    book_rent = zookal_magento_client.find_by(isbn: 9781442531109, purchase_type: "Rent")
+
+Check if a book exists
+
+    book_buy_new.present?
+
+Get attributes
+    
+```    
+book_buy_new.url_with_params    # Full URL with specified params in `config/zookal_magento_rest_api.rb`
+book_buy_new.special_price      # Price
+book_buy_new.price              # RRP
+book_buy_new.author             # Author
+book_buy_new.sku                # SKU
+book_buy_new.name               # Name
+book_buy_new.edition            # Edition
+book_buy_new.publisher          # Publisher
+book_buy_new.year               # Year
+book_buy_new.pages              # Pages
+```
+    
+Get list of all attributes in console
+
+    $ book_buy_new.instance_variable_get("@table")
+
+Debugging
+
+    book_buy_new.meta_status  # HTTP status code, 200 for successful request, 4xx for client error, 5xx for server error
+    book_buy_new.meta_message # HTTP status message, e.g. "OK" for 200 or "Unauthorized" for 401
+    book_buy_new.meta_errors  # Array of detailed error messages, e.g. ["Invalid value for attribute purchase_type", "config.access_secret not specified in initializer file"]
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/zookal-magento-rest-api/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

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/lib/zookal_magento_rest_api/version.rb

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

data/lib/zookal_magento_rest_api.rb

@@ -0,0 +1,144 @@
+require "zookal_magento_rest_api/version"
+
+module ZookalMagentoRestApi
+  class << self
+    attr_accessor :consumer_key, :consumer_secret, :site, :access_key, :access_secret, :url_params
+  end
+
+  def self.configure(&block)
+    yield self
+  end  
+
+  class Client
+    require "oauth"
+    require "multi_json"
+    require "ostruct"
+
+    def find_by(opts)
+      @access_token ||= prepare_access_token       
+      
+      purchase_type_id = translate_purchase_type_to_purchase_type_id(opts[:purchase_type])      
+      
+      # rescue in case a configuration setting is missing, which will crash OAuth
+      response = @access_token.get("/api/rest/products?filter[1][attribute]=isbn&filter[1][eq]=#{opts[:isbn]}&filter[2][attribute]=purchase_type&filter[2][eq]=#{purchase_type_id}&filter[3][attribute]=status&filter[3][eq]=1") rescue nil
+      response_status = response.code.to_i rescue nil
+      response_message = response.message rescue nil
+      # decode response body and rescue if there's a ParseError (e.g. when Magento returns HTML after invalid authentication)
+      if response        
+        begin
+          response_body_decoded = MultiJson.decode(response.body)
+        rescue MultiJson::ParseError => exception
+          puts "MultiJson::ParseError"
+          puts exception
+          response_body_decoded = nil
+        end
+      else
+        response_body_decoded = nil
+      end
+      response_o_auth_error_message = get_oauth_error_message(response_body_decoded)      
+
+      attributes = get_book_attributes(response_body_decoded)
+      entity_id = get_entity_id(attributes, response_body_decoded)
+
+      attributes[:meta_status] = response_status if response_status
+      attributes[:meta_message] = response_message if response_message
+      errors = get_errors(opts, purchase_type_id, response_o_auth_error_message)      
+      attributes[:meta_errors] = errors if errors
+      
+      attributes[:present?] = is_book_present?(attributes)
+      url_with_params = get_url_with_params(attributes, entity_id)
+      attributes[:url_with_params] = url_with_params if url_with_params
+
+      OpenStruct.new(attributes)    
+    end
+
+  private
+
+    def prepare_access_token
+      consumer = OAuth::Consumer.new(ZookalMagentoRestApi.consumer_key, ZookalMagentoRestApi.consumer_secret, :site => ZookalMagentoRestApi.site)
+      token_hash = {oauth_token: ZookalMagentoRestApi.access_key, oauth_token_secret: ZookalMagentoRestApi.access_secret}
+      access_token = OAuth::AccessToken.from_hash(consumer, token_hash)
+    end
+
+    def translate_purchase_type_to_purchase_type_id(purchase_type)
+      return nil unless purchase_type.is_a? String
+      case purchase_type.downcase
+        when "buy new" then 56
+        when "rent" then 55        
+        else return nil
+      end
+    end
+
+    def get_oauth_error_message(response_body_decoded)
+      response_body_decoded["messages"]["error"].first["message"] rescue nil
+    end
+
+    def get_book_attributes(response_body_decoded)
+      sku = response_body_decoded.values.first["sku"] rescue nil
+      sku ? response_body_decoded.values.first : {}
+    end
+
+    def get_entity_id(attributes, response_body_decoded)
+      return nil unless attributes.any?
+      response_body_decoded.keys.first
+    end
+
+    def get_errors(opts, purchase_type_id, response_o_auth_error_message)
+      errors = []
+
+      unless ZookalMagentoRestApi.consumer_key
+        errors << "config.consumer_key not specified in initializer file"
+      end
+
+      unless ZookalMagentoRestApi.consumer_secret
+        errors << "config.consumer_secret not specified in initializer file"
+      end
+
+      unless ZookalMagentoRestApi.site
+        errors << "config.site not specified in initializer file"
+      end
+
+      unless ZookalMagentoRestApi.access_key
+        errors << "config.access_key not specified in initializer file"
+      end
+
+      unless ZookalMagentoRestApi.access_secret
+        errors << "config.access_secret not specified in initializer file"
+      end                                          
+
+      unless opts.has_key?(:isbn)
+        errors << "Attribute isbn not specified"
+      end
+
+      unless opts.has_key?(:purchase_type)
+        errors << "Attribute purchase_type not specified"
+      end
+
+      unless purchase_type_id
+        errors << "Invalid value for attribute purchase_type"
+      end
+
+      if response_o_auth_error_message
+        errors << response_o_auth_error_message
+      end      
+
+      errors.any? ? errors : nil
+    end
+
+    def is_book_present?(attributes)
+      attributes["sku"] ? true : false
+    end
+
+    def get_url_with_params(attributes, entity_id)
+      return nil unless ZookalMagentoRestApi.site && attributes["url_key"] && entity_id
+      
+      url = "#{ZookalMagentoRestApi.site}/catalog/product/view/id/#{entity_id}"
+      if ZookalMagentoRestApi.url_params
+        url = url + "?#{ZookalMagentoRestApi.url_params}"
+      end
+      
+      url             
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+# ENV["RAILS_ENV"] ||= 'test'
+require "zookal_magento_rest_api"
+require "pry"
+require "webmock/rspec"
+
+
+RSpec.configure do |config|  
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = "random"
+  
+  # when a focus tag is present in RSpec, only run tests with focus tag: http://railscasts.com/episodes/285-spork
+  config.filter_run :focus => true
+  config.run_all_when_everything_filtered = true  
+end
+
+# http://stackoverflow.com/questions/19075907/clean-solution-for-resetting-class-variables-in-between-rspec-tests/19079701#19079701
+def reset_class_variables(cl)
+  cl.class_variables.each do |var|
+    cl.class_variable_set var, nil
+  end
+end

data/spec/zookal_magento_rest_api_spec.rb

@@ -0,0 +1,188 @@
+require "spec_helper"
+
+describe ZookalMagentoRestApi::Client do  
+  response_body_book_buy_new = "{\"2378\":{\"status\":\"1\", \"sku\":\"978123432423\", \"url_key\":\"marketing-and-the-law\"}}"
+  response_body_unauthorized = "{\"messages\":{\"error\":[{\"code\":401,\"message\":\"oauth_problem=consumer_key_rejected\"}]}}"
+  after(:each) do
+    reset_class_variables ZookalMagentoRestApi
+  end
+
+  context "when a configuration attribute is missing in the initializer file" do            
+    it "set the correct attributes" do
+      ZookalMagentoRestApi.consumer_key = nil
+      ZookalMagentoRestApi.consumer_secret = "secret"
+      ZookalMagentoRestApi.site = "https://www.zookal.com"
+      ZookalMagentoRestApi.access_key = "key"
+      ZookalMagentoRestApi.access_secret = "secret"
+
+      magento_client = ZookalMagentoRestApi::Client.new
+
+      WebMock.stub_request(:get, "https://www.zookal.com/api/rest/products?filter[1][attribute]=isbn&filter[1][eq]=123&filter[2][attribute]=purchase_type&filter[2][eq]=56&filter[3][attribute]=status&filter[3][eq]=1")
+           .to_return(:status => 401,
+                      :body => response_body_unauthorized
+                      )
+      book = magento_client.find_by(isbn: 123, purchase_type: "Buy New")
+      expect(book.meta_status).to eq 401
+      expect(book.meta_errors.count).to eq 2
+      expect(book.meta_errors.first).to eq "config.consumer_key not specified in initializer file"
+      expect(book.present?).to be_false
+    end
+  end
+
+  context "when two configuration attributes are missing in the initializer file" do            
+    it "set the correct attributes" do
+      ZookalMagentoRestApi.consumer_key = nil
+      ZookalMagentoRestApi.consumer_secret = "secret"
+      ZookalMagentoRestApi.site = "https://www.zookal.com"    
+      ZookalMagentoRestApi.access_key = nil
+      ZookalMagentoRestApi.access_secret = "secret"
+
+      magento_client = ZookalMagentoRestApi::Client.new
+
+      WebMock.stub_request(:get, "https://www.zookal.com/api/rest/products?filter[1][attribute]=isbn&filter[1][eq]=123&filter[2][attribute]=purchase_type&filter[2][eq]=56&filter[3][attribute]=status&filter[3][eq]=1")
+           .to_return(:status => 401,
+                      :body => response_body_unauthorized
+                      )
+      book = magento_client.find_by(isbn: 123, purchase_type: "Buy New")
+      expect(book.meta_status).to eq 401
+      expect(book.meta_errors.count).to eq 3
+      expect(book.meta_errors[0]).to eq "config.consumer_key not specified in initializer file"
+      expect(book.meta_errors[1]).to eq "config.access_key not specified in initializer file"
+      expect(book.present?).to be_false      
+    end
+  end
+
+  context "when no book was found" do            
+    it "set the correct attributes" do
+      ZookalMagentoRestApi.consumer_key = "key"
+      ZookalMagentoRestApi.consumer_secret = "secret"
+      ZookalMagentoRestApi.site = "https://www.zookal.com"    
+      ZookalMagentoRestApi.access_key = "key"
+      ZookalMagentoRestApi.access_secret = "secret"
+
+      magento_client = ZookalMagentoRestApi::Client.new
+
+      WebMock.stub_request(:get, "https://www.zookal.com/api/rest/products?filter[1][attribute]=isbn&filter[1][eq]=123&filter[2][attribute]=purchase_type&filter[2][eq]=56&filter[3][attribute]=status&filter[3][eq]=1")
+           .to_return(:status => 200,
+                      :body => "[]"
+                      )
+      book = magento_client.find_by(isbn: 123, purchase_type: "Buy New")
+      expect(book.meta_status).to eq 200
+      expect(book.meta_errors).to be_nil
+      expect(book.special_price).to be_nil
+      expect(book.present?).to be_false
+    end
+  end  
+
+  context "when purchase_type was not specified" do            
+    it "set the correct attributes" do
+      ZookalMagentoRestApi.consumer_key = "key"
+      ZookalMagentoRestApi.consumer_secret = "secret"
+      ZookalMagentoRestApi.site = "https://www.zookal.com"    
+      ZookalMagentoRestApi.access_key = "key"
+      ZookalMagentoRestApi.access_secret = "secret"
+
+      magento_client = ZookalMagentoRestApi::Client.new
+
+      WebMock.stub_request(:get, "https://www.zookal.com/api/rest/products?filter[1][attribute]=isbn&filter[1][eq]=123&filter[2][attribute]=purchase_type&filter[2][eq]=&filter[3][attribute]=status&filter[3][eq]=1")
+           .to_return(:status => 200,
+                      :body => response_body_book_buy_new
+                      )
+      book = magento_client.find_by(isbn: 123)
+      expect(book.meta_status).to eq 200
+      expect(book.meta_errors.count).to eq 2      
+      expect(book.meta_errors[0]).to eq "Attribute purchase_type not specified"
+      expect(book.present?).to be_true      
+    end
+  end
+
+  context "when isbn was not specified" do            
+    it "set the correct attributes" do
+      ZookalMagentoRestApi.consumer_key = "key"
+      ZookalMagentoRestApi.consumer_secret = "secret"
+      ZookalMagentoRestApi.site = "https://www.zookal.com"    
+      ZookalMagentoRestApi.access_key = "key"
+      ZookalMagentoRestApi.access_secret = "secret"
+
+      magento_client = ZookalMagentoRestApi::Client.new
+
+      WebMock.stub_request(:get, "https://www.zookal.com/api/rest/products?filter[1][attribute]=isbn&filter[1][eq]=&filter[2][attribute]=purchase_type&filter[2][eq]=56&filter[3][attribute]=status&filter[3][eq]=1")
+           .to_return(:status => 200,
+                      :body => response_body_book_buy_new
+                      )
+      book = magento_client.find_by(purchase_type: "Buy New")
+      expect(book.meta_status).to eq 200
+      expect(book.meta_errors.count).to eq 1
+      expect(book.meta_errors[0]).to eq "Attribute isbn not specified"      
+      expect(book.present?).to be_true      
+    end
+  end
+
+  context "when invalid purchase_type was entered" do            
+    it "set the correct attributes" do
+      ZookalMagentoRestApi.consumer_key = "key"
+      ZookalMagentoRestApi.consumer_secret = "secret"
+      ZookalMagentoRestApi.site = "https://www.zookal.com"    
+      ZookalMagentoRestApi.access_key = "key"
+      ZookalMagentoRestApi.access_secret = "secret"
+
+      magento_client = ZookalMagentoRestApi::Client.new
+
+      WebMock.stub_request(:get, "https://www.zookal.com/api/rest/products?filter[1][attribute]=isbn&filter[1][eq]=123&filter[2][attribute]=purchase_type&filter[2][eq]=&filter[3][attribute]=status&filter[3][eq]=1")
+           .to_return(:status => 200,
+                      :body => response_body_book_buy_new
+                      )
+      book = magento_client.find_by(isbn: 123, purchase_type: "Bbla")
+      expect(book.meta_status).to eq 200
+      expect(book.meta_errors.count).to eq 1
+      expect(book.meta_errors.first).to eq "Invalid value for attribute purchase_type"
+      expect(book.present?).to be_true            
+    end
+  end
+
+  context "when requested book was found and no url params exists" do            
+    it "set the correct attributes" do
+      ZookalMagentoRestApi.consumer_key = "key"
+      ZookalMagentoRestApi.consumer_secret = "secret"
+      ZookalMagentoRestApi.site = "https://www.zookal.com"    
+      ZookalMagentoRestApi.access_key = "key"
+      ZookalMagentoRestApi.access_secret = "secret"
+      ZookalMagentoRestApi.url_params = nil
+
+      magento_client = ZookalMagentoRestApi::Client.new
+
+      WebMock.stub_request(:get, "https://www.zookal.com/api/rest/products?filter[1][attribute]=isbn&filter[1][eq]=123&filter[2][attribute]=purchase_type&filter[2][eq]=56&filter[3][attribute]=status&filter[3][eq]=1")
+           .to_return(:status => 200,
+                      :body => response_body_book_buy_new
+                      )
+      book = magento_client.find_by(isbn: 123, purchase_type: "Buy New")
+      expect(book.meta_status).to eq 200
+      expect(book.meta_errors).to be_nil
+      expect(book.present?).to be_true
+      expect(book.url_with_params).to eq "https://www.zookal.com/catalog/product/view/id/2378"
+    end
+  end
+
+  context "when requested book was found and url params exists" do            
+    it "set the correct attributes" do
+      ZookalMagentoRestApi.consumer_key = "key"
+      ZookalMagentoRestApi.consumer_secret = "secret"
+      ZookalMagentoRestApi.site = "https://www.zookal.com"    
+      ZookalMagentoRestApi.access_key = "key"
+      ZookalMagentoRestApi.access_secret = "secret"
+      ZookalMagentoRestApi.url_params = "utm_source=company&utm_medium=affiliate&utm_campaign=2014"      
+
+      magento_client = ZookalMagentoRestApi::Client.new
+
+      WebMock.stub_request(:get, "https://www.zookal.com/api/rest/products?filter[1][attribute]=isbn&filter[1][eq]=123&filter[2][attribute]=purchase_type&filter[2][eq]=56&filter[3][attribute]=status&filter[3][eq]=1")
+           .to_return(:status => 200,
+                      :body => response_body_book_buy_new
+                      )
+      book = magento_client.find_by(isbn: 123, purchase_type: "Buy New")
+      expect(book.meta_status).to eq 200
+      expect(book.meta_errors).to be_nil
+      expect(book.present?).to be_true
+      expect(book.url_with_params).to eq "https://www.zookal.com/catalog/product/view/id/2378?utm_source=company&utm_medium=affiliate&utm_campaign=2014"
+    end
+  end                   
+end

data/zookal-magento-rest-api/.gitignore

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

data/zookal-magento-rest-api/Gemfile

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

data/zookal-magento-rest-api/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Michael Imstepf
+
+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/zookal-magento-rest-api/README.md

@@ -0,0 +1,29 @@
+# Zookal::Magento::Rest::Api
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'zookal-magento-rest-api'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install zookal-magento-rest-api
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/zookal-magento-rest-api/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 a new Pull Request

data/zookal-magento-rest-api/Rakefile

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

data/zookal-magento-rest-api/lib/zookal/magento/rest/api/version.rb

@@ -0,0 +1,9 @@
+module Zookal
+  module Magento
+    module Rest
+      module Api
+        VERSION = "0.0.1"
+      end
+    end
+  end
+end

data/zookal-magento-rest-api/lib/zookal/magento/rest/api.rb

@@ -0,0 +1,11 @@
+require "zookal/magento/rest/api/version"
+
+module Zookal
+  module Magento
+    module Rest
+      module Api
+        # Your code goes here...
+      end
+    end
+  end
+end

data/zookal-magento-rest-api/zookal-magento-rest-api.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'zookal/magento/rest/api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "zookal-magento-rest-api"
+  spec.version       = Zookal::Magento::Rest::Api::VERSION
+  spec.authors       = ["Michael Imstepf"]
+  spec.email         = ["michael.imstepf@gmail.com"]
+  spec.summary       = %q{TODO: Write a short summary. Required.}
+  spec.description   = %q{TODO: Write a longer description. Optional.}
+  spec.homepage      = ""
+  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.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

data/zookal_magento_rest_api.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'zookal_magento_rest_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "zookal_magento_rest_api"
+  spec.version       = ZookalMagentoRestApi::VERSION
+  spec.authors       = ["Michael Imstepf"]
+  spec.email         = ["michael.imstepf@gmail.com"]
+  spec.summary       = %q{Ruby wrapper for the Zookal Magento REST API}
+  spec.description   = %q{Gem to do backend REST API calls to Zookal's Magento store. Prior authentication (through oAuth) required.}
+  spec.homepage      = "https://github.com/Zookal/zookal-magento-rest-api"
+  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.add_dependency "oauth"
+  spec.add_dependency "multi_json"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "webmock"  
+  spec.add_development_dependency "pry"    
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: zookal_magento_rest_api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Michael Imstepf
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: oauth
+  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: multi_json
+  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: 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: rspec
+  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: webmock
+  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: pry
+  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'
+description: Gem to do backend REST API calls to Zookal's Magento store. Prior authentication
+  (through oAuth) required.
+email:
+- michael.imstepf@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/zookal_magento_rest_api.rb
+- lib/zookal_magento_rest_api/version.rb
+- spec/spec_helper.rb
+- spec/zookal_magento_rest_api_spec.rb
+- zookal-magento-rest-api/.gitignore
+- zookal-magento-rest-api/Gemfile
+- zookal-magento-rest-api/LICENSE.txt
+- zookal-magento-rest-api/README.md
+- zookal-magento-rest-api/Rakefile
+- zookal-magento-rest-api/lib/zookal/magento/rest/api.rb
+- zookal-magento-rest-api/lib/zookal/magento/rest/api/version.rb
+- zookal-magento-rest-api/zookal-magento-rest-api.gemspec
+- zookal_magento_rest_api.gemspec
+homepage: https://github.com/Zookal/zookal-magento-rest-api
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+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: Ruby wrapper for the Zookal Magento REST API
+test_files:
+- spec/spec_helper.rb
+- spec/zookal_magento_rest_api_spec.rb