foxycart 0.0.1

data/.gitignore

@@ -0,0 +1,3 @@
+.DS_Store
+.ruby-version
+.ruby-gemset

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Guardfile

@@ -0,0 +1,6 @@
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Dana Woodman, Teleporter.io
+
+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,67 @@
+# FoxyCart Ruby Library
+
+**THIS IS A WORK IN PROGRESS, COME BACK SOON!**
+
+A Ruby wrapper for the new FoxyCart Hypermedia REST API.
+
+## Installation
+
+```bash
+gem install foxycart
+```
+
+...or...
+
+```ruby
+gem 'foxycart'
+```
+
+## Usage
+
+Below is an example of how to create a store using the FoxyCart gem:
+
+```ruby
+require 'foxycart'
+
+FoxyCart.api_key = '<YOUR-KEY-HERE>'
+FoxyCart::Store.create(
+  :store_name => 'My Test Store',
+  :store_domain => 'some-subdomain',
+  :store_url => 'http://example.com',
+  :store_email => 'test@example.com',
+  :postal_code => '98765',
+  :country => 'US',
+  :region => 'CA',
+)
+```
+
+Check out the list of available interfaces below.
+
+## Reference
+
+**This is a work in progress, many features are still missing. The FoxyCart API itself is not finalized so this may change at any time!**
+
+### FoxyCart::Store
+
+[FoxyCart Store API Reference](http://api.foxycart.com/rels/store)
+
+Supported Methods:
+
+- `create`
+
+
+## Development
+
+1. Fork
+2. Make changes (and add tests/docs!)
+3. Submit pull request
+4. ???
+5. Profit!
+
+## License
+
+Released under the MIT license. See the `LICENSE` file for more details.
+
+## Credit
+
+Written by [Dana Woodman](http://danawoodman.com) and of [Teleporter.io](http://teleporter.io), based heavily on the [Stripe Ruby gem](https://github.com/stripe/stripe-ruby).

data/foxycart.gemspec

@@ -0,0 +1,34 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+
+require 'foxycart/version'
+require 'date'
+
+Gem::Specification.new do |s|
+  s.required_ruby_version = '>= 1.9.3'
+  s.authors = ['danawoodman', 'teleporter']
+  s.date = Date.today.strftime('%Y-%m-%d')
+  s.description = <<-HERE
+A Ruby interface FoxyCart Hypermedia RESTful API.
+  HERE
+  s.email = 'hire@teleporter.io'
+  s.extra_rdoc_files = %w[README.md LICENSE]
+  s.homepage = 'http://github.com/teleporter/foxycart'
+  s.license = 'MIT'
+  s.name = 'foxycart'
+  s.rdoc_options = ['--charset=UTF-8']
+  s.require_paths = ['lib']
+  s.summary = "Ruby interface to FoxyCart's Hypermedia RESTful API."
+  s.version = FoxyCart::VERSION
+  
+  s.add_dependency 'bundler', '~> 1.3'
+  s.add_dependency 'rest-client', '~> 1.6'
+
+  s.add_development_dependency 'rspec', '~> 2.14'
+  s.add_development_dependency 'guard', '~> 2.2'
+  s.add_development_dependency 'guard-rspec', '~> 4.0'
+
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables = `git ls-files -- bin/*`.split("\n").map { |file| File.basename(file) }
+end

data/lib/foxycart.rb

@@ -0,0 +1,78 @@
+require 'rest_client'
+
+# Version
+require 'foxycart/version'
+
+# API operations
+require 'foxycart/api_operations/create'
+# require 'foxycart/api_operations/update'
+# require 'foxycart/api_operations/delete'
+# require 'foxycart/api_operations/list'
+
+# Resources
+require 'foxycart/store'
+
+# Errors
+require 'foxycart/errors/foxycart_error'
+require 'foxycart/errors/authentication_error'
+
+module FoxyCart
+  @api_base = 'https://api-sandbox.foxycart.com'
+
+  class << self
+    attr_accessor :api_key
+  end
+
+  def self.api_url(url='')
+    @api_base + url
+  end
+
+  def self.request_headers(api_key)
+    {
+      'FOXYCART-API-VERSION' => '1', 
+      'Authorization' => "Bearer #{api_key}",
+    }
+  end
+
+  def self.request(method, url, api_key, params={}, headers={})
+    unless api_key ||= @api_key
+      raise AuthenticationError.new('No API key provided. ' +
+        'Set your API key using "FoxyCart.api_key = <API-KEY>".')
+    end
+
+    url = api_url(url)
+
+    case method.to_s.downcase.to_sym
+    when :get, :head, :delete
+      # Make params into GET parameters
+      url += "#{URI.parse(url).query ? '&' : '?'}#{uri_encode(params)}" if params && params.any?
+      payload = nil
+    else
+      payload = uri_encode(params)
+    end
+
+    # post(url, data: post_data, headers: FoxyCart.headers)
+    request_opts = {
+      :headers => request_headers(api_key).update(headers),
+      :method => method, 
+      :open_timeout => 30,
+      :payload => payload, 
+      :url => url, 
+      :timeout => 80
+    }
+
+    execute_request(request_opts)
+  end
+
+private
+
+  def self.uri_encode(params)
+    Util.flatten_params(params).
+      map { |k,v| "#{k}=#{Util.url_encode(v)}" }.join('&')
+  end
+
+  def self.execute_request(opts)
+    RestClient::Request.execute(opts)
+  end
+
+end

data/lib/foxycart/api_operations/create.rb

@@ -0,0 +1,16 @@
+module FoxyCart
+  module APIOperations
+    module Create
+      module ClassMethods
+        def create(params={})
+          response = FoxyCart.request(:post, self.url, params)
+          Util.convert_to_stripe_object(response, api_key)
+        end
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+    end
+  end
+end

data/lib/foxycart/errors/authentication_error.rb

@@ -0,0 +1,3 @@
+module FoxyCart
+  class AuthenticationError < FoxyCartError; end
+end

data/lib/foxycart/errors/foxycart_error.rb

@@ -0,0 +1,13 @@
+module FoxyCart
+  class FoxyCartError < StandardError
+    attr_reader :message
+
+    def initialize(message=nil)
+      @message = message
+    end
+
+    def to_s
+      "#{@message}"
+    end
+  end
+end

data/lib/foxycart/store.rb

@@ -0,0 +1,32 @@
+module FoxyCart
+  class Store
+    include FoxyCart::APIOperations::Create
+
+    @store_version = 'https://admin.foxycart.com/v/0.7.2/'
+    @country = 'US'
+
+    def url
+      "/users/#{@user_id}/stores"
+    end
+
+    # def create(params={})
+    #   @user_id = params['user_id']
+    #   @name = params['name']
+    #   @domain = @name.parameterize
+    #   @url = params['url']
+    #   @email = params['email']
+    #   @zip = params['zip']
+    #   @state = params['state']
+    # end
+      #     {
+      #   :store_version_uri => @store_version,
+      #   :store_name => @name,
+      #   :store_domain => @domain,
+      #   :store_url => @url,
+      #   :store_email => @email,
+      #   :postal_code => @zip,
+      #   :country => @country,
+      #   :region => @state,
+      # }
+  end
+end

data/lib/foxycart/util.rb

@@ -0,0 +1,36 @@
+module FoxyCart
+  class Util
+    def self.url_encode(key)
+      URI.escape(key.to_s, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
+    end
+
+    def self.flatten_params(params, parent_key=nil)
+      result = []
+      params.each do |key, value|
+        calculated_key = parent_key ? "#{parent_key}[#{url_encode(key)}]" : url_encode(key)
+        if value.is_a?(Hash)
+          result += flatten_params(value, calculated_key)
+        elsif value.is_a?(Array)
+          result += flatten_params_array(value, calculated_key)
+        else
+          result << [calculated_key, value]
+        end
+      end
+      result
+    end
+
+    def self.flatten_params_array(value, calculated_key)
+      result = []
+      value.each do |elem|
+        if elem.is_a?(Hash)
+          result += flatten_params(elem, calculated_key)
+        elsif elem.is_a?(Array)
+          result += flatten_params_array(elem, calculated_key)
+        else
+          result << ["#{calculated_key}[]", elem]
+        end
+      end
+      result
+    end
+  end
+end

data/lib/foxycart/version.rb

@@ -0,0 +1,3 @@
+module FoxyCart
+  VERSION = '0.0.1'
+end

data/spec/foxycart/store_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+require 'foxycart'
+
+describe "Store" do
+  before :each do 
+    FoxyCart.api_key = 'asdf'
+  end
+
+  it "does stuff" do
+    puts FoxyCart.api_key
+    # FoxyCart::Store.create(
+    #   :store_name => 'My Test Store',
+    #   :store_domain => 'some-subdomain',
+    #   :store_url => 'http://example.com',
+    #   :store_email => 'test@example.com',
+    #   :postal_code => '98765',
+    #   :country => 'US',
+    #   :region => 'CA',
+    # )
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: foxycart
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- danawoodman
+- teleporter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-08 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: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: ! 'A Ruby interface FoxyCart Hypermedia RESTful API.
+
+'
+email: hire@teleporter.io
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- foxycart.gemspec
+- lib/foxycart.rb
+- lib/foxycart/api_operations/create.rb
+- lib/foxycart/api_operations/delete.rb
+- lib/foxycart/api_operations/list.rb
+- lib/foxycart/api_operations/update.rb
+- lib/foxycart/errors/authentication_error.rb
+- lib/foxycart/errors/foxycart_error.rb
+- lib/foxycart/store.rb
+- lib/foxycart/util.rb
+- lib/foxycart/version.rb
+- spec/foxycart/store_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/teleporter/foxycart
+licenses:
+- MIT
+post_install_message: 
+rdoc_options:
+- --charset=UTF-8
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+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: Ruby interface to FoxyCart's Hypermedia RESTful API.
+test_files:
+- spec/foxycart/store_spec.rb
+- spec/spec_helper.rb