magento_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 863a2bcdfb1270dd14149d8ba79ceaffd88d6e98
+  data.tar.gz: d823b7fd2902ed18899d70398b4ab69e2ab5482b
+SHA512:
+  metadata.gz: d8bd43b19c6aaf0ac764d6ee3552436467919698c63a7ab476fe22eec7e6125e6b49d48cee7ceca76a878a4baf782c58467f1594c1dfcf3fa2090fab308a6e09
+  data.tar.gz: c4230df3bf8820f9db387d7614b9e7fe2cea7665539538633b90f56ad519713065b0cf0133512d06dcbe43a2c5fa9538cbf2a1369797c5239c467fc761fe1294

data/.gitignore

@@ -0,0 +1,11 @@
+.ruby-version
+.bundle/
+log/*.log
+pkg/
+spec/dummy/db/*.sqlite3
+spec/dummy/log/*.log
+spec/dummy/tmp/
+spec/dummy/.sass-cache
+.1grep-*
+*.gem
+Gemfile.lock

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Nicholas Fetchak
+
+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,22 @@
+# MagentoClient
+
+A Ruby interface to Magento's REST API
+
+The main feature is automatic OAuth handshake with Magento - the OAuth access token is automatically fetched, so automated scripts can use Magento's REST API without needing any manual steps
+
+## Usage
+
+```
+magento = MagentoClient.new({
+	:url => 'http://my_magento_store.com',
+	:key => 'OAuth Consumer Key',
+	:secret => 'OAuth Consumer Secret',
+	:username => 'Magento Admin username',
+	:password => 'Magento Admin password',
+})
+
+products = magento.get('/api/rest/products')
+
+puts "Fetched #{products.count} products"
+```
+

data/lib/magento_client.rb

@@ -0,0 +1,46 @@
+require 'oauth'
+require 'httparty'
+require 'http-cookie'
+require 'nokogiri'
+require 'multi_json'
+
+require 'magento_client/version'
+require 'magento_client/handshake'
+
+class MagentoClient
+  include Handshake
+
+  def initialize(config = {})
+    @config = OpenStruct.new(config)
+  end
+
+  def get(params)
+    MultiJson.load(access_token.get(params).body)
+  end
+
+  def access_token
+    return @access_token if @access_token
+
+    code = get_verifier_code
+    @access_token = request_token.get_access_token(:oauth_verifier => code)
+  end
+
+  def request_token
+    @request_token ||= consumer.get_request_token
+  end
+
+  def consumer
+    @consumer ||= OAuth::Consumer.new(@config.key, @config.secret,
+      :site => @config.url,
+      :request_token_path => "/index.php/oauth/initiate",
+      :authorize_path => "/index.php/admin/oauth_authorize",
+      :access_token_path => "/index.php/oauth/token",
+      :http_method => :get
+    )
+  end
+
+  def reset
+    @consumer = @request_token = nil
+  end
+end
+

data/lib/magento_client/handshake.rb

@@ -0,0 +1,58 @@
+class MagentoClient
+  module Handshake
+    def get_verifier_code
+      jar = HTTP::CookieJar.new
+
+      authorize_url = request_token.authorize_url
+      response = HTTParty.get(authorize_url)
+      jar.parse(response.headers['set-cookie'], authorize_url)
+      
+      doc = Nokogiri::HTML.fragment(response.body)
+      form = extract_form(doc.css('form#loginForm'))
+      form[:vars]['login[username]'] = @config.username
+      form[:vars]['login[password]'] = @config.password
+
+
+      response = HTTParty.post(form[:action],
+        :body => form[:vars],
+        :headers => { 'Cookie' => HTTP::Cookie.cookie_value(jar.cookies(form[:action])) }
+      )
+      jar.parse(response.headers['set-cookie'], form[:action])
+
+      doc = Nokogiri::HTML.fragment(response.body)
+      form = extract_form(doc.css('form#oauth_authorize_confirm'))
+      raise "Didn't get a token value" unless form[:vars]['oauth_token']
+
+
+      response = HTTParty.get(form[:action],
+        :query => form[:vars],
+        :headers => { 'Cookie' => HTTP::Cookie.cookie_value(jar.cookies(form[:action])) }
+      )
+      jar.parse(response.headers['set-cookie'], form[:action])
+      verifier_code = extract_verifier_code(response.body)
+      raise "Didn't get a verifier code" unless verifier_code
+
+      verifier_code
+    end
+
+
+    private
+
+    def extract_verifier_code(body)
+      body.match(/Verifier code: (\w+)/) do
+        return $1
+      end
+    end
+
+    def extract_form(form)
+      {
+        :vars => form.css('input').each_with_object({}) do |e, obj|
+            obj[e.attr('name')] = e.attr('value')
+          end,
+        
+        :action => form.attr('action')
+      }
+    end
+
+  end
+end

data/lib/magento_client/version.rb

@@ -0,0 +1,3 @@
+class MagentoClient
+  VERSION = "0.1.0"
+end

data/magento_client.gemspec

@@ -0,0 +1,27 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+# Maintain your gem's version:
+require "magento_client/version"
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |spec|
+  spec.name          = "magento_client"
+  spec.version       = MagentoClient::VERSION
+  spec.authors       = ["Nicholas Fetchak"]
+  spec.email         = ["gitcommits@fetchak.com"]
+  spec.summary       = "A Ruby interface to Magento's REST API"
+  spec.description   = "A Ruby interface to Magento's REST API with automatic OAuth handshaking"
+  spec.homepage      = "https://github.com/fetchak/magento_client"
+  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", "~> 0"
+  spec.add_dependency "httparty", "~> 0"
+  spec.add_dependency "http-cookie", "~> 1.0"
+  spec.add_dependency "nokogiri", "~> 1.6"
+  spec.add_dependency "multi_json", "~> 1"
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: magento_client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nicholas Fetchak
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-01 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: httparty
+  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: http-cookie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+description: A Ruby interface to Magento's REST API with automatic OAuth handshaking
+email:
+- gitcommits@fetchak.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- MIT-LICENSE
+- README.md
+- lib/magento_client.rb
+- lib/magento_client/handshake.rb
+- lib/magento_client/version.rb
+- magento_client.gemspec
+homepage: https://github.com/fetchak/magento_client
+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.4.5
+signing_key: 
+specification_version: 4
+summary: A Ruby interface to Magento's REST API
+test_files: []
+has_rdoc: