zinc 0.1.0

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/Gemfile.lock

@@ -0,0 +1,30 @@
+PATH
+  remote: .
+  specs:
+    zinc (0.0.1)
+      rest-client (~> 1.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    mime-types (1.21)
+    rake (10.0.3)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec (2.10.0)
+      rspec-core (~> 2.10.0)
+      rspec-expectations (~> 2.10.0)
+      rspec-mocks (~> 2.10.0)
+    rspec-core (2.10.1)
+    rspec-expectations (2.10.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.10.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake
+  rspec
+  zinc!

data/README.rdoc

@@ -0,0 +1,36 @@
+= Zinc Ruby Bindings
+
+== Introduction
+Ruby bindings for the {Zinc}[https://zinc.io] API
+
+Heavily inspired by the {Stripe Ruby Bindings}[https://github.com/stripe/stripe-ruby]
+
+By Julian Simioni
+
+== Usage
+
+   Zinc.api_key = "your-api-key" # set the API key first
+
+   new_order = Zinc::Order.create({:address => {
+        :name =>"Tim Beaver",
+        :address_line1 => "77 Massachusetts Avenue",
+        :zip_code => "02139",
+        :city": "Cambridge",
+        :state": "MA",
+        :country": "US"
+     },
+     :address_suggestion_choice => "suggested",
+     :products => [
+        {
+           :pid => "B003L1ZYYM",
+           :pid_type => "ASIN",
+        },
+        {
+           :pid => "0833030477",
+           :pid_type => "ASIN",
+        }
+     ]})
+
+
+     # all parameters returned by the {Zinc API}[https://zinc.io/docs] can be used as accessors
+     puts new_order.ship_date_estimate # => 1336120454

data/Rakefile

@@ -0,0 +1,4 @@
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')
+
+task :default => :spec

data/lib/zinc.rb

@@ -0,0 +1,44 @@
+require 'json'
+require 'rest_client'
+
+require 'zinc/order'
+
+require 'zinc/errors/authentication_error'
+
+module Zinc
+	@@url_base = 'https://api.zinc.io/v1/'
+	@@api_key = nil
+
+	def self.api_key=(key)
+		@@api_key = key
+	end
+
+	def self.api_key
+		@@api_key
+	end
+
+	def self.url_base
+		@@url_base
+	end
+
+	def self.request(method, url, params)
+		raise AuthenticationError unless api_key
+
+		if method == :post and params == {}
+			return
+		end
+
+		opts = {
+			:method => method,
+			:user => api_key,
+			:url => url,
+			:payload => params.to_json,
+		}
+		response = execute_request(opts)
+		return JSON.parse(response)
+	end
+
+	def self.execute_request(opts)
+		RestClient::Request.execute(opts)
+	end
+end

data/lib/zinc/errors/authentication_error.rb

@@ -0,0 +1,4 @@
+module Zinc
+	class AuthenticationError < StandardError
+	end
+end

data/lib/zinc/order.rb

@@ -0,0 +1,40 @@
+module Zinc
+	class Order
+		def self.create(params = {})
+			o = Order.new
+			response = Zinc.request(:post, url, params)
+			if response
+				o.set_values(response)
+			end
+			o
+		end
+
+		def self.get(id)
+			o = Order.new
+			response = Zinc.request(:get, url+'/'+id, {})
+			if response
+				o.set_values(response)
+			end
+			o
+		end
+
+		def self.url
+			Zinc.url_base+'orders'
+		end
+
+		def set_values(values)
+			@values = values
+		end
+
+		def method_missing(name, *args)
+			@values ||= {}
+			if name.to_s.end_with?('=')
+				@values[name.to_s] = args[0]
+			else
+				@values[name.to_s]
+			end
+		end
+
+		private
+	end
+end

data/spec/api_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe Zinc do
+	context "API Bindings" do
+		before(:each) do
+			@mock = mock
+			Zinc.api_key = 'foo'
+			Zinc.mock_rest_client = @mock
+		end
+
+		it "doesn't use the network when creating a new Order object" do
+			@mock.should_receive(:get).never
+			Zinc::Order.create
+		end
+
+		it "returns a response object when Zinc.request called" do
+			data = {'foo' => "bar"}
+			@mock.should_receive(:post).once.and_return(test_response(data))
+			response = Zinc.request(:post, Zinc::Order.url, data)
+			response.should == data
+		end
+
+		context "create object with params" do
+			before(:each) do
+				expects = {:user => Zinc.api_key, :method => :post, :url => Zinc::Order.url, :payload => test_order_create.to_json}
+				@mock.should_receive(:post).once.with(expects).and_return(test_response(test_order_response))
+				@order = Zinc::Order.create(test_order_create)
+			end
+
+			it "sends a post request"do
+			end
+
+			it "returns an order object with accessible attributes" do
+				@order.merchant.should == test_order_response[:merchant]
+				@order.created_date.should == test_order_response[:created_date]
+			end
+
+			it "request sends API key as user" do
+			end
+		end
+
+		context "get existing object" do
+			it "returns an order object when get called with id" do
+				id = test_order_response[:id]
+				expects = {:url => Zinc::Order.url+'/'+id, :user => Zinc.api_key, :method => :get, :payload => {}.to_s}
+				@mock.should_receive(:get).once.with(expects).and_return(test_response(test_order_response))
+				@order = Zinc::Order.get(id)
+
+				@order.id.should == id
+				@order.merchant.should == test_order_response[:merchant]
+			end
+		end
+	end
+end

data/spec/credentials_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+module Zinc
+	describe Zinc do
+		context "credentials" do
+			it "throws an error if request made without api credentials" do
+				Zinc.api_key = nil
+				expect { Zinc::Order.create }.to raise_error(Zinc::AuthenticationError)
+			end
+		end
+	end
+end

data/spec/order_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+module Zinc
+	describe Zinc do
+		before(:each) do
+			Zinc.api_key = 'foo'
+		end
+
+		context "Order object" do
+			it "returns an Order object when a create class method is called" do
+				Zinc::Order.create.class.should == Zinc::Order
+			end
+
+			it "returns full API url through self.url" do
+				Zinc::Order.url.should == 'https://api.zinc.io/v1/orders'
+			end
+		end
+	end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'rspec'
+require 'zinc'
+
+require 'test_content'
+require 'test_helper'
+
+RSpec.configure do |config|
+	config.color_enabled = true
+	config.formatter     = 'documentation'
+end

data/spec/test_content.rb

@@ -0,0 +1,83 @@
+def test_order_create
+	{
+		:mode  =>"dev",
+		:max_total => 6000,
+		:address => {
+		  :name => "Tim Beaver",
+			:address_line1 => "77 Massachusetts Avenue",
+			:address_line2 => nil,
+			:zip_code => "02139",
+			:city => "Cambridge",
+			:state => "MA",
+			:country => "US"
+		},
+		:address_suggestion_choice => "suggested",
+		:products => [
+			{
+				:pid => "B003L1ZYYM",
+				:pid_type => "ASIN",
+				:qty => 1
+			},
+			{
+				:pid => "0833030477",
+				:pid_type => "ASIN",
+				:qty => 1
+			}
+			],
+		:merchant => "amazon",
+		:gift_ship => true,
+		:gift_message => "Thanks for ordering from example.com!",
+		:shipping_method => "standard"
+	}
+end
+
+def test_order_response
+	{
+  :_type => "order",
+  :id => "xyg2rfplly",
+  :mode => "live",
+  :order_total => 2040,
+  :fee => 40,
+  :max_total => 4000,
+  :address => {
+       :_type =>"address",
+       :name => "Tim Beaver",
+       :address_line1 => "77 Massachusetts Avenue",
+       :address_line2 => nil,
+       :zip_code => "02139",
+       :city => "Cambridge",
+       :state => "MA",
+       :country => "US"
+  },
+  :address_original => nil,
+  :address_suggested => nil,
+  :address_suggestion_choice => nil,
+  :products => [
+     {
+         :_type => "product",
+         :pid => "B003L1ZYYM",
+         :pid_type => "ASIN",
+         :qty => 1,
+         :price => 1500
+     }
+  ],
+  :merchant => "amazon",
+  :gift_ship => false,
+  :gift_message => nil,
+  :shipping_method => "standard",
+  :shipping_cost => 500,
+  :status => {
+     :_type => "status",
+     :state => "active",
+     :code =>  "processed",
+     :message =>  "Your order has been processed with the merchant and is awaiting shipment."
+  },
+  :created_date => 1336100454,
+  :ship_date => nil,
+  :delivery_date => nil,
+  :ship_date_estimate => 1336120454,
+  :delivery_date_estimate => 1336705254,
+  :tracking_number => nil,
+  :tracking_type => nil
+ }
+end

data/spec/test_helper.rb

@@ -0,0 +1,24 @@
+module Zinc
+	@mock_rest_client = nil
+
+	def self.mock_rest_client=(mock_client)
+		@mock_rest_client = mock_client
+	end
+
+	def self.execute_request(opts)
+		case opts[:method]
+		when :post then @mock_rest_client.post opts
+		when :get then @mock_rest_client.get opts
+		end
+	end
+end
+
+class TestResponse
+	attr_accessor :code, :body
+end
+
+def test_response(body)
+	if body.class == Hash
+		body.to_json.to_s
+	end
+end

data/zinc.gemspec

@@ -0,0 +1,17 @@
+spec = Gem::Specification.new do |s|
+	s.name = 'zinc'
+	s.version = '0.1.0'
+	s.summary = 'Ruby bindings for the Zinc(https://zinc.io) API'
+	s.description = s.summary
+	s.authors = ['Julian Simioni']
+	s.email = ['julian.simioni@gmail.com']
+
+	s.add_dependency('rest-client', '~> 1.4')
+
+	s.add_development_dependency('rspec')
+	s.add_development_dependency('rake')
+
+	s.files = `git ls-files`.split("\n")
+	s.test_files    = `git ls-files -- spec/*`.split("\n")
+	s.require_paths = ['lib']
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: zinc
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Julian Simioni
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !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: 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'
+description: Ruby bindings for the Zinc(https://zinc.io) API
+email:
+- julian.simioni@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- README.rdoc
+- Rakefile
+- lib/zinc.rb
+- lib/zinc/errors/authentication_error.rb
+- lib/zinc/order.rb
+- spec/api_spec.rb
+- spec/credentials_spec.rb
+- spec/order_spec.rb
+- spec/spec_helper.rb
+- spec/test_content.rb
+- spec/test_helper.rb
+- zinc.gemspec
+homepage: 
+licenses: []
+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.24
+signing_key: 
+specification_version: 3
+summary: Ruby bindings for the Zinc(https://zinc.io) API
+test_files:
+- spec/api_spec.rb
+- spec/credentials_spec.rb
+- spec/order_spec.rb
+- spec/spec_helper.rb
+- spec/test_content.rb
+- spec/test_helper.rb