bigcartel-api 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8394aeb53563b44d32a5b410ff3e237c88f13364
+  data.tar.gz: bc61e7136220fd7512c4d8beb34c260ca0873b9c
+SHA512:
+  metadata.gz: 730ae996d6baab3277989018c5b4b47ebd58992e89da315d6ee2d1c6fd33790e96a17c8d873219f0e3e6fb1584d46fd129b6fe4438fd84f8243bfb93071ffd20
+  data.tar.gz: 9f67cc67807bb236bd3a950a52a076678ecd11cd34514184b9c8be0ce38511ea8cd9fd35a4d137a595149259bdd73ac9b5a6648b1ea3738e96a4ebe0ae1a47a5

data/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bigcartel.gemspec
+gemspec
+
+group :development do
+  gem 'dotenv'
+end
+
+group :test do
+  gem 'rspec'
+  gem 'webmock'
+  gem 'vcr'
+  gem 'dotenv'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Dylan Montgomery
+
+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,57 @@
+# Bigcartel
+
+The bigcartel-api gem is a ruby wrapper for interacting with the Bigcartel API.
+Developed for [Hipment](http://hipment.com).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bigcartel-api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bigcartel-api
+
+## Getting Started
+
+This gem requires a Bigcartel OAuth access token. There is a Bigcartel omniauth strategy here: [https://github.com/citizens/omniauth-bigcartel](https://github.com/citizens/omniauth-bigcartel)
+## Authentication
+
+```ruby
+Bigcartel.api_key = 'YOUR ACCESS TOKEN'
+```
+
+## Account
+To get information about the authenticated account:
+
+```ruby
+Bigcartel::Account.retrieve
+```
+
+## Orders
+To get all orders:
+
+```ruby
+Bigcartel::Order.all
+```
+
+To get a particular order:
+
+```ruby
+Bigcartel::Order.find(order_number)
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/citizens/bigcartel-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/Rakefile

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

data/bigcartel.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bigcartel/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bigcartel-api"
+  spec.version       = Bigcartel::VERSION
+  spec.authors       = ["Dylan Montgomery"]
+  spec.email         = ["mail@citizensinspace.com"]
+  spec.summary       = %q{Ruby wrapper for the Bigcartel API}
+  spec.homepage      = "https://github.com/citizens/bigcartel-api"
+  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.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_dependency 'rest-client'
+  spec.add_dependency 'json'
+  spec.add_dependency 'recursive-open-struct'
+  spec.add_dependency 'queryparams'
+end

data/lib/bigcartel.rb

@@ -0,0 +1,12 @@
+require 'recursive-open-struct'
+require "bigcartel/version"
+require "bigcartel/api"
+require "bigcartel/bigcartel_object"
+require "bigcartel/account"
+require "bigcartel/order"
+
+module Bigcartel
+  class << self
+    attr_accessor :api_key
+  end
+end

data/lib/bigcartel/account.rb

@@ -0,0 +1,14 @@
+module Bigcartel
+  class Account < BigcartelObject
+    class << self
+      def retrieve
+        response = Bigcartel::API.get("/account")
+        self.new(response)
+      end
+
+      def root_path
+        '/account'
+      end
+    end
+  end
+end

data/lib/bigcartel/api.rb

@@ -0,0 +1,26 @@
+require 'rest_client'
+require 'json'
+
+module Bigcartel
+  class API
+    class << self
+      def get(path)
+        normalize_response RestClient.get(api_url(path), authorization: "Bearer #{Bigcartel.api_key}")
+      end
+
+      private
+
+      def base_url
+        "https://api.bigcartel.com"
+      end
+
+      def normalize_response(response)
+        JSON.parse(response)
+      end
+
+      def api_url(path)
+        "#{base_url}#{path}"
+      end
+    end
+  end
+end

data/lib/bigcartel/bigcartel_object.rb

@@ -0,0 +1,20 @@
+module Bigcartel
+  class BigcartelObject < RecursiveOpenStruct
+    class << self
+      def all
+        resp = Bigcartel::API.get("#{root_path}")
+        resp['data'].map { |object| self.new(object) }
+      end
+
+      def find(id)
+        response = Bigcartel::API.get("#{root_path}/#{id}")
+        self.new(response)
+      end
+
+      def root_path
+        class_name = self.to_s.gsub(/^.*::/, '').downcase
+        "/#{class_name}s"
+      end
+    end
+  end
+end

data/lib/bigcartel/order.rb

@@ -0,0 +1,4 @@
+module Bigcartel
+  class Order < BigcartelObject
+  end
+end

data/lib/bigcartel/version.rb

@@ -0,0 +1,3 @@
+module Bigcartel
+  VERSION = "0.0.4"
+end

data/spec/account_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Bigcartel::Account, vcr: true do
+  it_should_behave_like 'a retrievable object', Bigcartel::Account, [
+    :id, :subdomain, :store_name, :contact_email, :url, :website
+  ]
+end

data/spec/order_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe Bigcartel::Order, vcr: true do
+  attributes = [
+    :number, :buyer_first_name, :buyer_first_name, :shipping_address_1, :shipping_address_1,
+    :shipping_address_2, :shipping_city, :shipping_state, :shipping_zip, :shipping_status,
+    :shipping_latitude, :shipping_longitude, :completed_at, :shipping_country, :items
+  ]
+
+  it_should_behave_like 'a findable object', ENV['BIGCARTEL_ORDER_ID'], attributes
+  it_should_behave_like 'a listable object', Bigcartel::Order, attributes
+end

data/spec/shared_examples/findable.rb

@@ -0,0 +1,9 @@
+RSpec.shared_examples 'a findable object' do |id, attributes|
+  let(:object) { VCR.use_cassette("#{subject.class.to_s}_#{id}") { subject.class.find(id) } }
+
+  attributes.each do |attribute|
+    it "should return a value for #{attribute}" do
+      expect(object.respond_to?(attribute)).to be true
+    end
+  end
+end

data/spec/shared_examples/listable.rb

@@ -0,0 +1,14 @@
+RSpec.shared_examples 'a listable object' do |subject, attributes = []|
+  let(:list) { VCR.use_cassette(subject.to_s) { subject.all } }
+
+  it "should return an array of objects" do
+    expect(list.class).to eq Array
+    expect(list.first.class).to eq subject
+  end
+
+  attributes.each do |attribute|
+    it "should return a value for #{attribute}" do
+      expect(list.first.respond_to?(attribute)).to be true
+    end
+  end
+end

data/spec/shared_examples/retrievable.rb

@@ -0,0 +1,9 @@
+RSpec.shared_examples 'a retrievable object' do |subject, attributes|
+  let(:object) { VCR.use_cassette(subject.to_s) { subject.retrieve } }
+
+  attributes.each do |attribute|
+    it "should return a value for #{attribute}" do
+      expect(object.respond_to?(attribute)).to be true
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,110 @@
+require 'bigcartel'
+require 'vcr'
+require 'dotenv'
+
+Dotenv.load
+Bigcartel.api_key = ENV['BIGCARTEL_TOKEN']
+
+# Load shared examples
+Dir['./spec/shared_examples/**/*.rb'].sort.each { |f| require f }
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/fixtures/vcr_cassettes'
+  c.hook_into :webmock
+  c.ignore_localhost = false
+  c.configure_rspec_metadata!
+  c.default_cassette_options = { record: :once }
+end
+
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # 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
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: bigcartel-api
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- Dylan Montgomery
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  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: json
+  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: recursive-open-struct
+  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: queryparams
+  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'
+description: 
+email:
+- mail@citizensinspace.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bigcartel.gemspec
+- lib/bigcartel.rb
+- lib/bigcartel/account.rb
+- lib/bigcartel/api.rb
+- lib/bigcartel/bigcartel_object.rb
+- lib/bigcartel/order.rb
+- lib/bigcartel/version.rb
+- spec/account_spec.rb
+- spec/order_spec.rb
+- spec/shared_examples/findable.rb
+- spec/shared_examples/listable.rb
+- spec/shared_examples/retrievable.rb
+- spec/spec_helper.rb
+homepage: https://github.com/citizens/bigcartel-api
+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.7
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for the Bigcartel API
+test_files:
+- spec/account_spec.rb
+- spec/order_spec.rb
+- spec/shared_examples/findable.rb
+- spec/shared_examples/listable.rb
+- spec/shared_examples/retrievable.rb
+- spec/spec_helper.rb