ecwid_api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f75df6f53fd6f55913cf94526d41c5cf68272ebc
+  data.tar.gz: e1a2a10f1141300974719d4998c962c617ce44c3
+SHA512:
+  metadata.gz: 43e85267b0ff0a21482048c8436dc460e3045305acf73d876e0e329f8c7e90b3b62e0f76b341574735fa27e914d04ad7df7950dc44446ecd857955b54b0e6093
+  data.tar.gz: 044b281f10380c226f1e987b771297d56fa5ee6f213ccd5f4ed771cf628d37646e9c1abae4872096f29cc384b02eb3ab4298e0bd090b4eca4ecbaff122ceb06a

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 David Biehl
+
+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,90 @@
+# EcwidApi
+
+A gem to interface with the Ecwid REST APIs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ecwid_api'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ecwid_api
+
+## Usage
+
+### Configure an new Client
+
+A `Client` will interface with a single Ecwid store. The `store_id` will need
+to be configured for each new `Client`.
+
+    require 'ecwid_api'
+
+    client = EcwidApi::Client.new do |config|
+      config.store_id           = '12345'                        # your Ecwid Store ID
+      config.url                = 'https://app.ecwid.com/api/v1' # default
+      config.order_secret_key   = 'ORDER_SECRET_KEY'
+      config.product_secret_key = 'PRODUCT_SECRET_KEY'
+    end
+
+### Make some Requests
+
+To make a request, simply call the `#get` method on the client passing in the
+API and any parameters it requires. For example, to get some categories:
+
+    # GET https://app.ecwid.com/api/v1/[STORE-ID]/categories?parent=1
+
+    client.get("categories", parent: 1)
+
+    # => #<Faraday::Response>
+
+The `Client` is responsible for making raw requests, which is why it returns
+a `Faraday::Response`. Eventually there will be a domain model to bury this
+detail under an abstraction. In the meantime, please see the
+[Faraday documentation](https://github.com/lostisland/faraday)
+to learn how to use the `Faraday::Response` object.
+
+### Ecwid API Documentation
+
+The [Ecwid API documentation](http://kb.ecwid.com/w/page/25232810/API)
+should give you a good idea of what is possible to retreive. Please note that
+resources requiring the secret keys will be inaccessible until we implement
+that feature.
+
+## Contributing
+
+1. Fork it ( http://github.com/davidbiehl/ecwid_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
+
+## License
+
+The MIT License (MIT)
+
+Copyright (c) 2014 David Biehl
+
+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/Rakefile

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

data/ecwid_api.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ecwid_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ecwid_api"
+  spec.version       = EcwidApi::VERSION
+  spec.authors       = ["David Biehl"]
+  spec.email         = ["me@davidbiehl.com"]
+  spec.summary       = %q{A client for the Ecwid REST API}
+  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.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.14.1"
+
+  spec.add_dependency "faraday", "~> 0.9.0"
+end

data/lib/ecwid_api/client.rb

@@ -0,0 +1,86 @@
+require 'faraday'
+
+module EcwidApi
+  # Public: Client objects manage the connection and interface to a single Ecwid
+  # store.
+  #
+  # Examples
+  #
+  #   client = EcwidApi::Client.new do |config|
+  #     config.store_id = '12345'
+  #     config.url = 'http://app.ecwid.com/api/v1'
+  #     config.order_secret_key = 'ORDER_SECRET_KEY'
+  #     config.product_secret_key = 'PRODUCT_SECRET_KEY'
+  #   end
+  #
+  class Client
+    # The default base URL for the Ecwid API
+    DEFAULT_URL = "https://app.ecwid.com/api/v1"
+
+    # Public: Returns the Ecwid Store ID
+    attr_reader :store_id
+
+    # Public: Gets or sets the Order API Secret Key for the Ecwid Store
+    attr_accessor :order_secret_key
+
+    # Public: Gets or sets the default Product API Secret Key for the Ecwid Store
+    attr_accessor :product_secret_key
+
+    def initialize
+      yield(self) if block_given?
+      raise Error.new("The store_id is required") unless store_id
+    end
+
+    # Public: Returns the base URL of the Ecwid API
+    def url
+      @url || DEFAULT_URL
+    end
+
+    # Public: Sets the base URL for the Ecwid API
+    def url=(url)
+      reset_connection
+      @url = url
+    end
+
+    # Public: Sets the Ecwid Store ID
+    def store_id=(store_id)
+      reset_connection
+      @store_id = store_id
+    end
+
+    # Public: The URL of the API for the Ecwid Store
+    def store_url
+      "#{url}/#{store_id}"
+    end
+
+    # Public: Sends a GET request to the Ecwid API
+    #
+    # path   - The String path for the URL of the request without the base URL
+    # params - A Hash of query string parameters
+    #
+    # Examples
+    #
+    #   # Gets the Categories where the parent Category is 1
+    #   client.get("categories", parent: 1)
+    #   # => #<Faraday::Response>
+    #
+    # Returns a Faraday::Response
+    def get(path, params={})
+      connection.get(path, params)
+    end
+
+    private
+
+    # Private: Resets the connection.
+    #
+    # Should be used if the base URL to the Ecwid API changes
+    def reset_connection
+      @connection = nil
+    end
+
+    # Private: Returns a Faraday connection to interface with the Ecwid API
+    def connection
+      @connection ||= Faraday.new(url: store_url)
+    end
+  end
+end

data/lib/ecwid_api/error.rb

@@ -0,0 +1,3 @@
+module EcwidApi
+  class Error < StandardError; end;
+end

data/lib/ecwid_api/version.rb

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

data/lib/ecwid_api.rb

@@ -0,0 +1,34 @@
+require "ecwid_api/version"
+
+# Public: This is the main namespace for the EcwidApi. It can be used to store
+# the default client.
+#
+module EcwidApi
+  autoload :Client, "ecwid_api/client"
+  autoload :Error, "ecwid_api/error"
+
+  class << self
+    # Public: Gets and configures a default client
+    #
+    # To configure the default client, just pass a block.
+    #
+    # Examples
+    #
+    #   EcwidApi.default_client do |config|
+    #     config.store_id = '12345'
+    #     config.order_secret_key = 'ORDER_SECRET_KEY'
+    #     config.product_secret_key = 'PRODUCT_SECRET_KEY'
+    #   end
+    #
+    #   client = EcwidApi.default_client.store_id
+    #   # => "12345"
+    #
+    # Returns an EcwidApi::Client, or null if one hasn't been configured
+    def default_client(&block)
+      if block_given?
+        @default_client = Client.new(&block)
+      end
+      @default_client
+    end
+  end
+end

data/spec/client_spec.rb

@@ -0,0 +1,61 @@
+require "spec_helper"
+
+describe EcwidApi::Client do
+  subject do
+    EcwidApi::Client.new do |config|
+      config.store_id = store_id
+    end
+  end
+  let(:store_id) { 12345 }
+
+  context "without a store_id" do
+    it "raises an error" do
+      expect { EcwidApi::Client.new }.to raise_error(EcwidApi::Error, /store_id/)
+    end
+  end
+
+  describe "#url" do
+    its(:url) { "http://app.ecwid.com/api/v1" }
+
+    it "can be overridden" do
+      client = EcwidApi::Client.new do |config|
+        config.store_id = store_id
+        config.url = "http://ladida.com"
+      end
+
+      client.url.should == "http://ladida.com"
+    end
+  end
+
+  describe "#store_url" do
+    its(:store_url) { "http://app.ecwid.com/api/v1/12345" }
+  end
+
+  describe "#get" do
+    let(:faraday_stubs) do
+      Faraday::Adapter::Test::Stubs.new do |stub|
+        stub.get('categories') { [200, {}, '[]'] }
+      end
+    end
+
+    let(:faraday) do
+      Faraday::new do |builder|
+        builder.adapter :test, faraday_stubs
+      end
+    end
+
+    before(:each) do
+      allow(subject).to receive(:connection).and_return(faraday)
+    end
+
+    it "delegates to the Faraday connection" do
+      expect(subject.send(:connection)).to receive(:get).with("categories", parent: 1)
+
+      subject.get "categories", parent: 1
+    end
+
+    it "returns a Faraday::Response" do
+      subject.get("categories", parent: 1).is_a?(Faraday::Response).should be_true
+    end
+  end
+end

data/spec/ecwid_api_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe EcwidApi do
+  describe "::default_client" do
+    it "builds an EcwidApi::Client with the block" do
+      EcwidApi.default_client.should be_nil
+
+      client = EcwidApi.default_client do |config|
+        config.store_id = 123
+      end
+
+      client.is_a?(EcwidApi::Client).should be_true
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require "ecwid_api"
+
+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
+
+  # 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'
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: ecwid_api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- David Biehl
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-06 00:00:00.000000000 Z
+dependencies:
+- !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: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+description: 
+email:
+- me@davidbiehl.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ecwid_api.gemspec
+- lib/ecwid_api.rb
+- lib/ecwid_api/client.rb
+- lib/ecwid_api/error.rb
+- lib/ecwid_api/version.rb
+- spec/client_spec.rb
+- spec/ecwid_api_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.0.3
+signing_key: 
+specification_version: 4
+summary: A client for the Ecwid REST API
+test_files:
+- spec/client_spec.rb
+- spec/ecwid_api_spec.rb
+- spec/spec_helper.rb