bigcommerce 0.10.0 → 1.0.0.beta

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+cache: bundler
+
+# http://docs.travis-ci.com/user/workers/container-based-infrastructure/
+sudo: false
+
+rvm:
+  - jruby-head
+  - ruby-head
+  - rbx-2.2.10
+  - 2.2.1
+  - 2.1.5
+  - 2.0.0
+  - 1.9.3
+  - jruby-19mode

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+## Next Release
+
+* Your contribution here.
+
+## 1.0.0
+Please note that this is the start of a new major release which breaks all backward compatibility.
+
+* [#89](https://github.com/bigcommerce/bigcommerce-api-ruby/pull/89): Complete rewrite of Bigcommerce API Client. - [@pedelman](https://github.com/pedelman).
+
+## 0.x (Legacy)
+For the old version of the API Client please view the [0.x branch](https://github.com/bigcommerce/bigcommerce-api-ruby/tree/0.x).

data/CONTRIBUTING.md

@@ -0,0 +1,119 @@
+# Contributing to Bigcommerce
+
+
+We would love to see contributors! You're encouraged to submit [pull requests](https://github.com/bigcommerce/bigcommerce-api-ruby/pulls), [propose features, and discuss issues](https://github.com/bigcommerce/bigcommerce-api-ruby/issues).
+
+#### Fork the Project
+
+Fork the [project on Github](https://github.com/bigcommerce/bigcommerce-api-ruby) and check out your copy.
+
+```
+git clone your_forked_version_of_bigcommerce_api_ruby
+cd bigcommerce-api-ruby
+git remote add upstream https://github.com/bigcommerce/bigcommerce-api-ruby.git
+```
+
+#### Create a Feature Branch
+
+Make sure your fork is up-to-date and create a topic branch for your feature or bug fix.
+
+```
+git checkout master
+git pull upstream master
+git checkout -b my-feature-branch
+```
+
+#### Bundle Install and Test
+
+Ensure that you can build the project and run tests.
+
+```
+bundle install
+bundle exec rake
+```
+
+#### Installing the gem locally (useful to run examples)
+
+This will build the gem locally into the pkg directory, you can then install it manually by targeting that directory specifically.
+
+```
+bundle exec rake build
+gem install pkg/bigcommerce-1.x.x.gem
+```
+
+#### Write Tests
+
+Try to write a test that reproduces the problem you're trying to fix or describes a feature that you want to build. Add to [spec/bigcommerce](spec/bigcommerce).
+
+We definitely appreciate pull requests that highlight or reproduce a problem, even without a fix.
+
+#### Write Code
+
+Implement your feature or bug fix.
+
+Ruby style is enforced with [Rubocop](https://github.com/bbatsov/rubocop), run `bundle exec rubocop` and fix any style issues highlighted.
+
+Make sure that `bundle exec rake` completes without errors.
+
+#### Write Documentation
+
+Document any external behavior in the [README](README.md).
+
+#### Update Changelog
+
+Add a line to [CHANGELOG](CHANGELOG.md) under *Next Release*. Make it look like every other line, including your name and link to your Github account.
+
+#### Commit Changes
+
+Make sure git knows your name and email address:
+
+```
+git config --global user.name "Your Name"
+git config --global user.email "contributor@example.com"
+```
+
+Writing good commit logs is important. A commit log should describe what changed and why.
+
+```
+git add ...
+git commit
+```
+
+#### Push
+
+```
+git push origin my-feature-branch
+```
+
+#### Make a Pull Request
+
+Go to https://github.com/contributor/bigcommerce-api-ruby and select your feature branch. Click the 'Pull Request' button and fill out the form. Pull requests are usually reviewed within a few days.
+
+#### Rebase
+
+If you've been working on a change for a while, rebase with upstream/master.
+
+```
+git fetch upstream
+git rebase upstream/master
+git push origin my-feature-branch -f
+```
+
+#### Update CHANGELOG Again
+
+Update the [CHANGELOG](CHANGELOG.md) with the pull request number. A typical entry looks as follows.
+
+```
+* [#123](https://github.com/bigcommerce/bigcommerce-api-ruby/pull/123): Added products resource - [@contributor](https://github.com/contributor).
+```
+
+Amend your previous commit and force push the changes.
+
+```
+git commit --amend
+git push origin my-feature-branch -f
+```
+
+#### Check on Your Pull Request
+
+Go back to your pull request after a few minutes and see whether it passed muster with Travis-CI. Everything should look green, otherwise fix issues and amend your commit as described above.

data/DEPENDENCIES.md

@@ -0,0 +1,7 @@
+### Bigcommerce 💙  Open Source
+
+Many thanks to the contributors and authors of the following libraries!
+
+- [Faraday](https://github.com/lostisland/faraday) Simple, but flexible HTTP client library, with support for multiple backends. - [MIT](https://github.com/lostisland/faraday/blob/master/LICENSE.md)
+- [Faraday Middleware](https://github.com/lostisland/faraday_middleware) Various Faraday middlewares for Faraday-based API wrappers. - [MIT](https://github.com/lostisland/faraday_middleware/blob/master/LICENSE.md)
+- [Hashie](https://github.com/intridea/hashie) Hashie is a collection of classes and mixins that make hashes more powerful. - [MIT](https://github.com/intridea/hashie/blob/master/LICENSE)

data/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+gemspec
+
+group :development do
+  gem 'pry'
+  gem 'rubocop'
+  gem 'guard'
+  gem 'guard-rspec'
+end
+
+group :test do
+  gem 'rspec'
+  gem 'simplecov'
+  gem 'coveralls'
+end

data/Guardfile

@@ -0,0 +1,22 @@
+guard 'rspec', all_on_start: false, cmd: 'bundle exec rspec' do
+  # Watch spec directory
+  watch(/^spec\/.+_spec\.rb/)
+
+  # Watch lib/*.rb
+  watch(/^lib\/(.+)\.rb/) do |m|
+    "spec/bigcommerce/#{m[1]}_spec.rb"
+  end
+
+  # Watch lib/bigcommerce/*.rb
+  watch(%r{^lib/bigcommerce/(.+).rb$}) do |m|
+    "spec/bigcommerce/unit/#{m[1]}_spec.rb"
+  end
+
+  # Watch lib/bigcommerce/(middleware|resources)/*.rb
+  watch(%r{^lib/bigcommerce/(middleware|resources)/(.+).rb$}) do |m|
+    "spec/bigcommerce/unit/#{m[1]}/#{m[2]}_spec.rb"
+  end
+
+  # Watch spec_helper
+  watch('spec/spec_helper.rb') { 'spec' }
+end

data/LICENSE

@@ -1,20 +1,20 @@
 Copyright (C) Bigcommerce, 2015.
 All rights reserved.
 
-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:
+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 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.
+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

@@ -1,4 +1,4 @@
-# Bigcommerce API V2 - Ruby Client
+# Bigcommerce
 
 [![Gem Version](https://badge.fury.io/rb/bigcommerce.png)](https://rubygems.org/gems/bigcommerce)
 [![Build Status](https://travis-ci.org/bigcommerce/bigcommerce-api-ruby.png?branch=master)](https://travis-ci.org/bigcommerce/bigcommerce-api-ruby)
@@ -6,104 +6,95 @@
 [![Code Climate](https://codeclimate.com/github/bigcommerce/bigcommerce-api-ruby.png)](https://codeclimate.com/github/bigcommerce/bigcommerce-api-ruby)
 [![Coverage Status](https://coveralls.io/repos/bigcommerce/bigcommerce-api-ruby/badge.png?branch=master)](https://coveralls.io/r/bigcommerce/bigcommerce-api-ruby?branch=master)
 
-This library provides a wrapper around the Bigcommerce REST API for use within
-Ruby apps or via the console.
+This is the official Bigcommerce API client to support our Rest API. You can find more information about becoming a Bigcommerce developer here: [developer.bigcommerce.com](http://developer.bigcommerce.com).
 
-### Note
+#### ⚠️ A note about the current client: ⚠️
+This is a preview release of the 1.0.0 version of the Bigcommerce API Client. Please report issues if they come up.
 
-If you find anything that is missing or needs clean up, please feel free to fork
-it and submit a changes with your pull request.
+We have introduced a new major version of the API client and it is a complete rewrite (for the better). If you want to see the old version of the API client, please view it here: [Bigcommerce API client v0.x](https://github.com/bigcommerce/bigcommerce-api-ruby/tree/0.x). We recommend that developers upgrade to the latest client, but we will still support our developers who are unable to upgrade.
 
-## Requirements
 
-- Ruby 1.9+
+## Installation
+Bigcommerce is available on Rubygems:
 
-To connect to the API, you need the following credentials:
+```sh
+gem install bigcommerce --pre
+```
 
-For the OAuth API:
+You can also add it to your Gemfile.
 
-- Create and register an app at [developer.bigcommerce.com](https://developer.bigcommerce.com).
-- Have a callback URL defined
-- Prepare the `client_id` credential
+```rb
+gem 'bigcommerce', '>= 1.0.0.beta'
+```
 
-For the Legacy API:
+## Getting Started
+In order to make requests to our API, you must register as a developer and have your credentials ready.
 
-- Secure URL pointing to a Bigcommerce store
-- Username of an authorized admin user of the store
-- API key for the user
+We currently have two different authentication schemes you can use depending on your use-case.
 
-A valid API key is required to authenticate requests. To grant API access for a user, go to Control Panel > Users > Edit User and make sure that the 'Enable API access?' checkbox is ticked.
+#### Public Apps
+Public apps can be submitted to Bigcommerce App Store, allowing other businesses to install it in their Bigcommerce stores.
 
-## Installation
+[More Information](https://developer.bigcommerce.com/api/using-oauth-intro)
 
-Download the lib folder and copy it to a path accessible within your app, or
-install the package directly from Rubygems:
+#### Private Apps
+To develop a custom integration for one store, your app needs to use Basic Authentication.
 
-```sh
-gem install bigcommerce
-```
+[More Information](https://developer.bigcommerce.com/api/legacy/basic-auth)
 
-## Configuration
+## Usage
+For full examples on using the API client, please see the [examples folder](examples).
 
-#### OAuth Authentication
+## Configuration
+In order to authenticate the API client, you will need to configure the client like this:
 
-In order to create a new Bigcommerce application, please visit [developer.bigcommerce.com](https://developer.bigcommerce.com). Its free to sign up and only takes a moment. Once you have created your app, you can get a `client_id`.
+#### Single Click (Public Apps):
 
-To use the API client in your Ruby code, provide the required credentials as
-follows:
+- ```client_id```: Obtained from the "My Apps" section on the [developer portal](http://developer.bigcommerce.com).
+- ```access_token```: Obtained after a token exchange in the auth callback.
+- ```store_hash```: Also obtained after the token exchange.
 
 ```rb
-require 'bigcommerce'
-
-api = Bigcommerce::Api.new({
-  :store_hash    => 'STORE_HASH',
-  :client_id     => 'CLIENT_ID',
-  :access_token  => 'ACCESS_TOKEN'
-})
+Bigcommerce.configure do |config|
+  config.store_hash = 'store_hash'
+  config.client_id = 'client_id'
+  config.access_token = 'access_token'
+end
 ```
 
-__NOTE:__ You do not need extra SSL certificates when connecting to the OAuth version of the api.
-
-#### Legacy Credentials
+#### Private Apps:
 
-To use the API client with the legacy credentials you can visit the main store page and under the "Setup & Tools" dropdown, you will see a link for the legacy API credentials.
+To get all the private app credentials, simply visit your store admin page and navigate to the Settings > Legacy API Settings. Once there, you can create a new username to authenticate with.
 
 ```rb
-require 'bigcommerce'
-
-api = Bigcommerce::Api.new({
-  :store_url => "https://store.mybigcommerce.com",
-  :username  => "username",
-  :api_key   => "api_key"
-})
+Bigcommerce.configure do |config|
+  config.auth = 'legacy'
+  config.url = 'https://api_path.com'
+  config.username = 'username'
+  config.api_key = 'api_key'
+end
 ```
 
-You can also enable SSL for the Legacy API.
+__SSL Configuration:__
 
-```rb
-require 'bigcommerce'
-
-api = Bigcommerce::Api.new({
-  :store_url => "https://store.mybigcommerce.com",
-  :username  => "username",
-  :api_key   => "api_key",
-  :ssl_client_cert  =>  OpenSSL::X509::Certificate.new(File.read("cert.pem")),
-  :ssl_client_key   =>  OpenSSL::PKey::RSA.new(File.read("key.pem"), "passphrase, if any"),
-  :ssl_ca_file      =>  "ca_certificate.pem",
-  :verify_ssl       =>  OpenSSL::SSL::VERIFY_PEER
-})
-```
-Remember that the fields `:ssl_client_cert`, `:ssl_client_key`, `:ssl_ca_file`
-and `:verify_ssl` are all required when enabling SSL certificates.
-
-## Connecting to the store
-
-Once you have authenticated with the OAuth or Legacy credentials, ping the time method to check that your configuration is working and you can connect successfully to the store:
+If you are using your own self-signed certificate, you can pass SSL options to Faraday. This is not required, but may be useful in special edge cases.
 
 ```rb
-ping = api.time()
+Bigcommerce.configure do |config|
+  config.auth = 'legacy'
+  config.url = 'https://api_path.com'
+  config.username = 'username'
+  config.api_key = 'api_key'
+  config.ssl = {
+    # Faraday options here
+  }
+end
 ```
 
-## Reference
+For more information about configuring SSL with Faraday, please see the following:
+
+- [Faraday SSL example](https://gist.github.com/mislav/938183)
+- [Setting up SSL certificates](https://github.com/lostisland/faraday/wiki/Setting-up-SSL-certificates)
 
-For full reference about the resources and supported endpoints, please see [developer.bigcommerce.com](https://developer.bigcommerce.com).
+## Contributing
+See [CONTRIBUTING.md](CONTRIBUTING.md)

data/RELEASING.md

@@ -0,0 +1,64 @@
+# Releasing Bigcommerce API Client
+
+There're no particular rules about when to release the Bigcommerce API client. Release bug fixes frequently, features not so frequently, and breaking API changes rarely.
+
+### Before A Release
+
+Run tests, check that all tests succeed locally.
+
+```sh
+bundle install
+bundle exec rake
+```
+
+This will ensure both style and that all the specs pass locally. Next, check that the last build succeeded in [Travis CI](https://travis-ci.org/bigcommerce/bigcommerce-api-ruby) for all supported platforms.
+
+Increment the version, modify [lib/bigcommerce/version.rb](lib/bigcommerce/version.rb).
+
+* Increment the third number (minor version) if the release has bug fixes and/or very minor features, only (eg. change `1.0.1` to `1.0.2`).
+* Increment the second number (patch version) if the release contains major features or breaking API changes (eg. change `1.0.10` to `1.1.0`).
+
+Change "Next Release" in [CHANGELOG.md](CHANGELOG.md) to the new version.
+
+```markdown
+1.1.0 (4/13/2015)
+=================
+```
+
+Commit your changes.
+
+```sh
+git add CHANGELOG.md lib/bigcommerce/version.rb
+git commit -m "Preparing for release, 1.1.0."
+git push origin master
+```
+
+### Release 🎉
+
+```sh
+$ rake release
+
+bigcommerce 1.1.0 built to pkg/bigcommerce-1.1.0.gem.
+Tagged v1.1.0.
+Pushed git commits and tags.
+Pushed bigcommerce 1.1.0 to rubygems.org.
+```
+
+### Prepare for the Next Version
+
+Add the next release to [CHANGELOG.md](CHANGELOG.md).
+
+```markdown
+Next Release
+============
+
+* Your contribution here.
+```
+
+Commit your changes.
+
+```sh
+git add CHANGELOG.md README.md
+git commit -m "Preparing for next release."
+git push origin master
+```