zookal_magento_rest_api 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bf6d8162f9afab5ccd2ded8c08185cb69f4947bc
-  data.tar.gz: 138417e1bf08fbfda6f85fbeac1f2eba8d7a4052
+  metadata.gz: c9c7c1423f6897af0039dcf6372b99a39a49281c
+  data.tar.gz: 83779b82196132076aef3074a4a28541cd4ed2d9
 SHA512:
-  metadata.gz: 2c0443d11fac83e0af948f798c28466468a6f42f56891ec3589aa0b61525f5a46030bc23d433c46404f3e2d1399cff4c942c5db0271873ef9fb45fdd8c22dc7c
-  data.tar.gz: 913e5ab08f2a9c5e94ef11da5ffd0b514a8f988c9867de497b1d8484f8ea207fee42e0371b61e0b0e1c2c2b27283b76d1ad9bd0bd31fd9b6fd2ac0e5cb677ebb
+  metadata.gz: 1d80553779530be363f323509ed1daf1cf8523e769de750e3be607a5f0f43589d6f1156a59c05aab3cf9791dc54feac11fddd8f99fd4e6d77e50cb4c75eac229
+  data.tar.gz: e439ece1923f3dfd2310c16d8b6165add6050ff2e85ff5779d35c7779d0a9e9326bd29d0d57bbbbaf965744d9ad86e3408c95ee3ef1c1b87c6468ecffc9f2c4a

data/README.md

@@ -20,14 +20,16 @@ Or install it yourself as:
 
 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
+```ruby
+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.
 
@@ -37,20 +39,26 @@ Information on how to obtain access_key and access_secret can be seen [here](htt
 
 Instantiate a client
 
-    zookal_magento_client = ZookalMagentoRestApi::Client.new
+```ruby
+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")
+```ruby
+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?
+```ruby
+book_buy_new.present?
+```
 
 Get attributes
     
-```    
+```ruby
 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
@@ -65,13 +73,17 @@ book_buy_new.pages              # Pages
     
 Get list of all attributes in console
 
-    $ book_buy_new.instance_variable_get("@table")
+```ruby
+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"]
+```ruby
+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
 

data/lib/zookal_magento_rest_api/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zookal_magento_rest_api
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Michael Imstepf
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-10 00:00:00.000000000 Z
+date: 2014-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth
@@ -125,14 +125,6 @@ files:
 - 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:

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

@@ -1,22 +0,0 @@
-*.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

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

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

@@ -1,22 +0,0 @@
-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

@@ -1,29 +0,0 @@
-# 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

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

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

@@ -1,9 +0,0 @@
-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

@@ -1,11 +0,0 @@
-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

@@ -1,23 +0,0 @@
-# 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