bigcommerce 0.10.0 → 1.0.0.beta

data/Rakefile

@@ -1,11 +1,13 @@
-require 'bundler/gem_tasks'
-require 'ci/reporter/rake/rspec'
 require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+require 'bigcommerce'
 
-Bundler::GemHelper.install_tasks
-
-RSpec::Core::RakeTask.new(:spec) do |spec|
+RSpec::Core::RakeTask.new do |spec|
   spec.pattern = 'spec/**/*_spec.rb'
+  spec.verbose = false
 end
 
-task :default => ['ci:setup:rspec', :spec]
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new(:rubocop)
+
+task default: [:rubocop, :spec]

data/bigcommerce.gemspec

@@ -1,59 +1,28 @@
-# -*- encoding: utf-8 -*-
-# stub: bigcommerce 0.9.0 ruby lib
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bigcommerce/version'
 
 Gem::Specification.new do |s|
-  s.name = "bigcommerce"
-  s.version = "0.10.0"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Mark Rickerby", "Rob Howard", "Saranyan Vigraham", "Sasha Gerrand"]
-  s.date = "2015-01-27"
-  s.description = "Enables Ruby applications to communicate with the Bigcommerce API V2."
+  s.name = 'bigcommerce'
+  s.homepage = 'https://github.com/bigcommerce/bigcommerce-api-ruby'
+  s.authors = ['Patrick Edelman']
+  s.version = Bigcommerce::VERSION
   s.license = 'MIT'
-  s.email = ["mark.rickerby@bigcommerce.com", "rob.howard@bigcommerce.com", "saranyan.vigraham@bigcommerce.com", "sasha.gerrand@bigcommerce.com"]
-  s.files = ["LICENSE", "Rakefile", "README.md", "bigcommerce.gemspec", "./lib/big_commerce.rb", "./lib/bigcommerce/api.rb", "./lib/bigcommerce/connection.rb", "./lib/bigcommerce/version.rb", "./lib/bigcommerce/resource.rb", "./lib/bigcommerce/product.rb", "./lib/bigcommerce.rb", "./spec/big_commerce_spec.rb", "./spec/integration/orders_spec.rb", "./spec/spec_helper.rb", "./spec/support/integration_context.rb", "./spec/support/mock_api_context.rb", "./spec/unit/api_request_spec.rb", "./spec/unit/api_spec.rb", "./spec/unit/connection_spec.rb", "./spec/unit/date_time_spec.rb", "./spec/unit/version_spec.rb", "spec/big_commerce_spec.rb", "spec/integration/orders_spec.rb", "spec/unit/api_request_spec.rb", "spec/unit/api_spec.rb", "spec/unit/connection_spec.rb", "spec/unit/date_time_spec.rb", "spec/unit/version_spec.rb"]
-  s.homepage = "http://github.com/bigcommerce/bigcommerce-api-ruby"
-  s.require_paths = ["lib"]
-  s.rubygems_version = "2.1.11"
-  s.summary = "Enables Ruby applications to communicate with the Bigcommerce API"
-  s.test_files = ["spec/big_commerce_spec.rb", "spec/integration/orders_spec.rb", "spec/unit/api_request_spec.rb", "spec/unit/api_spec.rb", "spec/unit/connection_spec.rb", "spec/unit/date_time_spec.rb", "spec/unit/version_spec.rb"]
 
-  if s.respond_to? :specification_version then
-    s.specification_version = 4
+  s.description = 'Bigcommerce API Ruby client library. Allows developers to \
+  easily communicate with the Bigcommerce API, for either CLI tools or public \
+  apps. More info: http://developer.bigcommerce.com'
+  s.summary = 'Ruby client library for the Bigcommerce v2 API'
+
+  s.required_ruby_version = '>= 1.9.3'
+  s.require_paths = ['lib']
+  s.files = `git ls-files`.split($ORS)
+  s.test_files = Dir['spec/**/*.rb']
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'bundler'
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<activesupport>, [">= 0"])
-      s.add_runtime_dependency(%q<json>, [">= 0"])
-      s.add_runtime_dependency(%q<rest-client>, [">= 0"])
-      s.add_development_dependency(%q<coveralls>, [">= 0"])
-      s.add_development_dependency(%q<ci_reporter_rspec>, [">= 0"])
-      s.add_development_dependency(%q<mocha>, [">= 0"])
-      s.add_development_dependency(%q<rake>, [">= 0"])
-      s.add_development_dependency(%q<rspec>, ["~> 2.11"])
-      s.add_development_dependency(%q<vcr>, [">= 0"])
-      s.add_development_dependency(%q<webmock>, ["= 1.9"])
-    else
-      s.add_dependency(%q<activesupport>, [">= 0"])
-      s.add_dependency(%q<json>, [">= 0"])
-      s.add_dependency(%q<rest-client>, [">= 0"])
-      s.add_dependency(%q<coveralls>, [">= 0"])
-      s.add_dependency(%q<ci_reporter_rspec>, [">= 0"])
-      s.add_dependency(%q<mocha>, [">= 0"])
-      s.add_dependency(%q<rake>, [">= 0"])
-      s.add_dependency(%q<rspec>, ["~> 2.11"])
-      s.add_dependency(%q<vcr>, [">= 0"])
-      s.add_dependency(%q<webmock>, ["= 1.9"])
-    end
-  else
-    s.add_dependency(%q<activesupport>, [">= 0"])
-    s.add_dependency(%q<json>, [">= 0"])
-    s.add_dependency(%q<rest-client>, [">= 0"])
-    s.add_dependency(%q<coveralls>, [">= 0"])
-    s.add_dependency(%q<ci_reporter_rspec>, [">= 0"])
-    s.add_dependency(%q<mocha>, [">= 0"])
-    s.add_dependency(%q<rake>, [">= 0"])
-    s.add_dependency(%q<rspec>, ["~> 2.11"])
-    s.add_dependency(%q<vcr>, [">= 0"])
-    s.add_dependency(%q<webmock>, ["= 1.9"])
-  end
+  s.add_dependency 'faraday'
+  s.add_dependency 'faraday_middleware'
+  s.add_dependency 'hashie'
 end

data/examples/README.md

@@ -0,0 +1,148 @@
+# Examples
+In this directory you can find examples which you may find helpful to reference in development. If you have some useful snippets, please feel free to open a PR into the appropriate file(s).
+
+#### Resource Reference
+For reference on the individual resources and the schema of the objects, please visit [developer.bigcommerce.com](https://developer.bigcommerce.com).
+
+## Configuration
+#### [Private Apps](configuration/legacy_auth.rb)
+Public apps (also known as Single-Click Apps) must use OAuth authentication.
+
+#### [Public Apps](configuration/oauth.rb)
+To develop a custom integration for one store, your app needs to use Basic Authentication.
+
+## Content
+#### [Blog Posts](content/blog_post.rb)
+A content entry in the store’s blog
+
+#### [Blog Tags](content/blog_tag.rb)
+Index of tags used on the store’s blog.
+
+#### [Redirects](content/redirect.rb)
+A 301 redirect, mapping from a given URL path to another URL
+
+## Customers
+#### [Customers](customers/customer.rb)
+Identity and account details for customers shopping on Bigcommerce stores
+
+#### [Customer Addresses](customers/customer_address.rb)
+Postal address belonging to a Customer
+
+#### [Customer Groups](customers/customer_group.rb)
+Grouping of customers who share the same level of access and discounts at a store
+
+## Geography
+#### [Countries](geography/country.rb)
+A country or territory, identifiable by an ISO 3166 country code
+
+#### [States](geography/state.rb)
+A state or province, identifiable by an ISO 3166 subdivision code
+
+## Marketing
+#### [Coupons](marketing/coupon.rb)
+Applies a category or product discount to an order for customers who enter a given code
+
+## Orders
+#### [Orders](orders/order.rb)
+The order object contains a record of the purchase agreement between a shopper and a merchant. 
+
+#### [Order Coupons](orders/order_coupon.rb)
+Coupon code applied to an order
+
+#### [Order Messages](orders/order_message.rb)
+Messages associated with an order.
+
+#### [Order Products](orders/order_product.rb)
+Product line items associated with an order.
+
+#### [Order Shipping Addresses](orders/order_shipping_address.rb)
+Shipping addresses associated with an order.
+
+#### [Order Statuses](orders/order_status.rb)
+Statuses that can be assigned to orders. Each status represents a state in the fulfilment workflow.
+
+#### [Order Taxes](orders/order_tax.rb)
+Taxes applied to an order.
+
+#### [Shipments](orders/shipment.rb)
+Shipping package consignments tracked from an order.
+
+## Payments
+#### [Payment Methods](payments/payment_methods.rb)
+Enabled payment methods.
+
+## Products
+#### [Brands](products/brand.rb)
+Brand facets for identifying and categorising products according to their manufacturer or company metonym.
+
+#### [Bulk Pricing Rules](products/bulk_pricing_rule.rb)
+Bulk pricing rules applied to a product.
+
+#### [Categories](products/category.rb)
+Index of hierarchical categories used to organise and group products.
+
+#### [Configurable Fields ](products/configurable_field.rb)
+Configurable fields associated with a product.
+
+#### [Custom Fields](products/custom_field.rb)
+Custom fields associated with a product.
+
+#### [Google Product Search Mappings](products/google_product_search_mapping.rb)
+Custom fields associated with a product.
+
+#### [Options](products/option.rb)
+Shared attributes that control value facets on a product.
+
+#### [Option Sets](products/option_set.rb)
+A reusable set of option facets that can be applied to products.
+
+#### [Option Set Options](products/option_set_option.rb)
+Options belonging to an option set.
+
+#### [Option Values](products/option_value.rb)
+Values that can be selected for an option.
+
+#### [Products](products/product.rb)
+Catalog of saleable items in the store.
+
+#### [Product Images](products/product_image.rb)
+Images associated with a product.
+
+#### [Product Options](products/product_option.rb)
+Options associated directly with a product.
+
+#### [Product Reviews](products/product_review.rb)
+Reviews associated to a product.
+
+#### [Product Rules](products/product_rule.rb)
+Rules that modify the default behaviour of products.
+
+#### [Product Videos](products/product_video.rb)
+Embedded videos displayed on product listings.
+
+#### [SKUs](products/sku.rb)
+Stock Keeping Unit identifiers associated with products.
+
+## Shipping
+#### [Shipping Methods](shipping/shipping_method.rb)
+List of enabled shipping methods.
+
+## Store
+#### [Store Information](store/store_info.rb)
+Metadata that describes the store.
+
+## System
+#### [Time](system/time.rb)
+Timestamp ping to check the system status.
+
+## Tax
+#### [Tax Classes](tax/tax_class.rb)
+Applies a category or product discount to an order for customers who enter a given code
+
+## Webhooks
+#### [Webhooks](webhooks/webhook.rb)
+Applies a category or product discount to an order for customers who enter a given code
+
+## Exception Handling
+#### [Exceptions](exception_handling.rb)
+All the errors we will throw with a convenient method to rescue the errors and take an action for each type

data/examples/configuration/legacy_auth.rb

@@ -0,0 +1,12 @@
+require 'bigcommerce'
+
+Bigcommerce.configure do |config|
+  config.auth = 'legacy'
+  # You will get this url when registering for an API key
+  config.url = ENV['BC_API_ENDPOINT_LEGACY']
+  config.username = ENV['BC_USERNAME']
+  config.api_key = ENV['BC_API_KEY']
+end
+
+puts Bigcommerce::System.time
+puts Bigcommerce.api_limit

data/examples/configuration/oauth.rb

@@ -0,0 +1,9 @@
+require 'bigcommerce'
+
+Bigcommerce.configure do |config|
+  config.store_hash = ENV['BC_STORE_HASH']
+  config.client_id = ENV['BC_CLIENT_ID']
+  config.access_token = ENV['BC_ACCESS_TOKEN']
+end
+
+puts Bigcommerce::System.time

data/examples/content/blog_post.rb

@@ -0,0 +1,39 @@
+require 'bigcommerce'
+
+Bigcommerce.configure do |config|
+  config.store_hash = ENV['BC_STORE_HASH']
+  config.client_id = ENV['BC_CLIENT_ID']
+  config.access_token = ENV['BC_ACCESS_TOKEN']
+end
+
+# List blog posts
+@posts = Bigcommerce::BlogPost.all(page: 1)
+puts @posts
+
+# Get a blog post
+puts Bigcommerce::BlogPost.find(@posts[0].id)
+
+# Get a count of blog posts
+puts Bigcommerce::BlogPost.count
+
+# Create a blog post
+@post = Bigcommerce::BlogPost.create(
+  title: 'Brand new producrts for sale!',
+  body: 'Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do \
+         eiusmod tempor incididunt ut labore et dolore magna aliqua. \
+         Excepteur sint occaecat cupidatat non proident, sunt in culpa qui \
+         officia deserunt mollit anim id est laborum.'
+)
+puts @post
+
+# Update a blog post
+puts Bigcommerce::BlogPost.update(
+  @post.id,
+  title: 'Oops wrong title.'
+)
+
+# Delete a blog post
+puts Bigcommerce::BlogPost.destroy(@post.id)
+
+# Delete all blog posts
+# puts Bigcommerce::BlogPost.destroy_all

data/examples/content/blog_tag.rb

@@ -0,0 +1,10 @@
+require 'bigcommerce'
+
+Bigcommerce.configure do |config|
+  config.store_hash = ENV['BC_STORE_HASH']
+  config.client_id = ENV['BC_CLIENT_ID']
+  config.access_token = ENV['BC_ACCESS_TOKEN']
+end
+
+# List blog tags
+puts Bigcommerce::BlogTag.all

data/examples/content/redirect.rb

@@ -0,0 +1,43 @@
+require 'bigcommerce'
+
+Bigcommerce.configure do |config|
+  config.store_hash = ENV['BC_STORE_HASH']
+  config.client_id = ENV['BC_CLIENT_ID']
+  config.access_token = ENV['BC_ACCESS_TOKEN']
+end
+
+# List redirects
+@redirects = Bigcommerce::Redirect.all(page: 1)
+puts @redirects
+
+# Get a redirect
+puts Bigcommerce::Redirect.find(@redirects[0].id)
+
+# Get a count of redirects
+puts Bigcommerce::Redirect.count
+
+# Create a redirect
+@redirect = Bigcommerce::Redirect.create(
+  path: '/womens_clothing',
+  forward: {
+    type: 'category',
+    ref: 3
+  }
+)
+puts @redirect
+
+# Update a redirect
+puts Bigcommerce::Redirect.update(
+  @redirect.id,
+  path: '/womens_clothing',
+  forward: {
+    type: 'category',
+    ref: 3
+  }
+)
+
+# Delete a redirect
+puts Bigcommerce::Redirect.destroy(@redirect.id)
+
+# Delete all redirects
+# puts Bigcommerce::Redirect.destroy_all

data/examples/customers/customer.rb

@@ -0,0 +1,36 @@
+require 'bigcommerce'
+
+Bigcommerce.configure do |config|
+  config.store_hash = ENV['BC_STORE_HASH']
+  config.client_id = ENV['BC_CLIENT_ID']
+  config.access_token = ENV['BC_ACCESS_TOKEN']
+end
+
+# List customers
+puts Bigcommerce::Customer.all(page: 1)
+
+# Get a customer
+puts Bigcommerce::Customer.find(1)
+
+# Get a count of customers
+puts Bigcommerce::Customer.count
+
+# Create a customer
+@customer = Bigcommerce::Customer.create(
+  first_name: 'Karl',
+  last_name: 'The Fog',
+  email: 'test@example.com'
+)
+puts @customer
+
+# Update a customer
+puts Bigcommerce::Customer.update(
+  @customer.id,
+  first_name: 'Karrrl'
+)
+
+# Delete a customer
+puts Bigcommerce::Customer.destroy(@customer.id)
+
+# Delete all customers
+# puts Bigcommerce::Customer.destroy_all

data/examples/customers/customer_address.rb

@@ -0,0 +1,50 @@
+require 'bigcommerce'
+
+Bigcommerce.configure do |config|
+  config.store_hash = ENV['BC_STORE_HASH']
+  config.client_id = ENV['BC_CLIENT_ID']
+  config.access_token = ENV['BC_ACCESS_TOKEN']
+end
+
+@customer = Bigcommerce::Customer.all[0]
+
+# List a customer address
+@customer_addresses = Bigcommerce::CustomerAddress.all(@customer.id)
+puts @customer_addresses
+
+# Get a customer address
+puts Bigcommerce::CustomerAddress.find(@customer.id, @customer_addresses[0].id)
+
+# Get a count of customer addresses
+puts Bigcommerce::CustomerAddress.count(@customer.id)
+
+# Get a count of all customer addresses for all customers
+puts Bigcommerce::CustomerAddress.count_all
+
+# Create a customer address
+@customer_address = Bigcommerce::CustomerAddress.create(
+  @customer.id,
+  first_name: 'Foo',
+  last_name: 'Bar',
+  phone: '5555555555',
+  street_1: '685 Market St.',
+  city: 'San Francisco',
+  state: 'California',
+  zip: '94019',
+  country: 'United States'
+)
+puts @customer_address
+
+# Update a customer address
+puts Bigcommerce::CustomerAddress.update(
+  @customer.id,
+  @customer_address.id,
+  first_name: 'Foo',
+  last_name: 'Bar'
+)
+
+# Delete a customer address
+puts Bigcommerce::CustomerAddress.destroy(@customer.id, @customer_address.id)
+
+# Delete all customer addresses
+# puts Bigcommerce::CustomerAddress.destroy_all(@customer.id)