heartland-retail 5.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d1bdee96767c0beb69e567edbce236959ce1305d420bc940586ac2732a6a27c5
+  data.tar.gz: de52df85cb38b7e011854862c49d6314bb065d3057fcb871624951057e537383
+SHA512:
+  metadata.gz: 86c7a3652a47396e2c9dc88cdc9697fdaf29cb7fcca32bf924dce5c230b773f31123cdc7e703455872bda24631aba5e7e03b2207cfa2310f2ac442f4dc7827ce
+  data.tar.gz: 92650387b74f3e380519d3c15d481c81f176714a1c01412158e877e2818cd0f913ded6256ff0de4d223de690b37acbbfe503a23c366b248104e9fb5019929810

data/.gitignore

@@ -0,0 +1,4 @@
+pkg
+.yardoc
+doc
+coverage

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,16 @@
+sudo: false
+language: ruby
+bundler_args: --without development
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - 2.2.0
+  - 2.6.0
+
+addons:
+  code_climate:
+    repo_token: 6963f51029c0c9bf6406bd1cc69ae951bc53f9bf7751b16035515b5f764c58fe
+
+after_success:
+  - bundle exec codeclimate-test-reporter

data/.yardopts

@@ -0,0 +1 @@
+--title "Heartland Retail Client"

data/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'rake'
+  gem 'rspec', '~> 3.2'
+  gem 'webmock', :require => false
+  gem 'coveralls', :require => false
+  gem 'codeclimate-test-reporter', '~> 1.0.0'
+end
+
+group :development do
+  gem 'pry'
+end

data/Gemfile.lock

@@ -0,0 +1,84 @@
+PATH
+  remote: .
+  specs:
+    heartland-retail (5.0.0)
+      faraday (< 1.0)
+      hashie
+      json (>= 1.7.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.2.8)
+    codeclimate-test-reporter (1.0.8)
+      simplecov (<= 0.13)
+    coderay (1.1.0)
+    coveralls (0.7.11)
+      multi_json (~> 1.10)
+      rest-client (>= 1.6.8, < 2)
+      simplecov (~> 0.9.1)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.1)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    faraday (0.17.3)
+      multipart-post (>= 1.2, < 3)
+    hashie (4.1.0)
+    json (2.3.0)
+    method_source (0.8.2)
+    mime-types (2.4.3)
+    multi_json (1.11.0)
+    multipart-post (2.1.1)
+    netrc (0.10.3)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (10.4.2)
+    rest-client (1.7.3)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
+    rspec (3.2.0)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+    rspec-core (3.2.2)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-mocks (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.2)
+    safe_yaml (1.0.4)
+    simplecov (0.9.2)
+      docile (~> 1.1.0)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.9.0)
+    simplecov-html (0.9.0)
+    slop (3.6.0)
+    term-ansicolor (1.3.0)
+      tins (~> 1.0)
+    thor (0.19.1)
+    tins (1.3.5)
+    webmock (1.17.4)
+      addressable (>= 2.2.7)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  codeclimate-test-reporter (~> 1.0.0)
+  coveralls
+  heartland-retail!
+  pry
+  rake
+  rspec (~> 3.2)
+  webmock
+
+BUNDLED WITH
+   1.17.2

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Heartland Retail
+
+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,272 @@
+# Heartland Retail API Client
+
+[![Gem Version](https://badge.fury.io/rb/springboard-retail.png)](http://badge.fury.io/rb/springboard-retail)
+[![Build Status](https://travis-ci.org/springboardretail/springboard-client-ruby.png?branch=master)](https://travis-ci.org/springboardretail/springboard-client-ruby)
+[![Code Climate](https://codeclimate.com/github/springboardretail/springboard-client-ruby.png)](https://codeclimate.com/github/springboardretail/springboard-client-ruby)
+[![Coverage Status](https://coveralls.io/repos/github/springboardretail/springboard-client-ruby/badge.svg?branch=master)](https://coveralls.io/github/springboardretail/springboard-client-ruby?branch=master)
+
+This is the [Heartland Retail](http://heartlandretail.us/) (a point-of-sale/retail management system) client library for Ruby. It provides access to the Heartland Retail HTTP API.
+
+It is a wrapper around the [Faraday](https://github.com/lostisland/faraday) HTTP client library.
+
+You can find [documentation here](http://rdoc.info/github/springboardretail/springboard-client-ruby).
+
+## Installation
+
+You need a recent version of libcurl and a sane build environment.
+
+Debian/Ubuntu:
+
+```bash
+sudo apt-get install build-essential libcurl4-openssl-dev
+gem install heartland-retail
+```
+
+## Connecting
+
+```ruby
+require 'heartland-retail'
+heartland = HeartlandRetail::Client.new(
+  'https://example.retail.heartland.us/api/',
+  token: 'secret_token'
+)
+```
+
+## Resource oriented
+
+```ruby
+resource = heartland[:items][1234]
+response = resource.get
+response = resource.delete
+
+# Query string generation:
+resource1 = heartland[:items]
+resource2 = resource.query(:key1 => 'val1', 'key with spaces' => 'val with spaces')
+resource2.uri.to_s
+# => "/items?key%20with%20spaces=val%20with%20spaces&key1=val1"
+```
+
+## URI oriented
+
+```ruby
+response = heartland.get '/items/1234'
+response = heartland.delete '/items/1234'
+item_count = heartland.count '/items'
+```
+
+## Collection Resources
+
+### Enumerable
+
+Resources include Ruby's Enumerable module for easy iteration over collections:
+
+```ruby
+heartland[:items].each do |item|
+  puts item['description']
+end
+
+item_count = heartland[:items].count
+
+usernames = heartland[:users].map {|user| user['login']}
+```
+
+### Filtering
+
+Resources have a `filter` method that support's Heartland Retail's advanced filter syntax:
+
+```ruby
+active_users = heartland[:users].filter(:active => true)
+active_users.each do |user|
+  # do something with each active user
+end
+
+# filter returns a new resource which allows for chaining:
+items = heartland[:items]
+active_items = items.filter(:active => true)
+active_items.filter(:price => {'$gt' => 10}).each do |item|
+   # ...
+end
+
+# filtering custom fields:
+heartland[:items].filter('custom@size'=> 'XL')
+```
+
+### Sorting
+
+Resources have a `sort` method that accepts any number of sort options. Note that each call to sort overwrites any previous sorts.
+
+```ruby
+resource.sort(:id, :price)
+resource.sort('created_at,desc')
+
+# returns a new resource for chaining:
+resource.sort(:description, :created_at).filter(:active => true).each do |item|
+  # ...
+end
+```
+
+### Returning select fields
+
+Resources have a `only` method that accepts any number of field keys to return only the selected fields. Note that each call to `only` overwrites any previous fields.
+
+```ruby
+resource.only(:id)
+resource.only(:public_id, :updated_at)
+
+# returns a new resource for chaining:
+resource.only(:public_id, :updated_at).filter(:active => true).each do |item|
+  # ...
+end
+```
+
+### Creating Resources
+
+Create a new resource via POST:
+
+```ruby
+collection = client[:items]
+response = collection.post! :description => 'Some New Item'
+response.status_line
+# => "HTTP/1.1 201 Created"
+
+# To fetch the newly created resource:
+new_item_response = response.resource.get!
+new_item_response[:description]
+# => "Some New Item"
+```
+
+### Embedding Related Resources
+
+Use the `embed` method to include the contents of related resource in the response body of each item in the collection:
+
+```ruby
+collection = client[:sales][:orders].embed(:customer, :location)
+collection.first.to_hash
+# => {
+  "id" => 1,
+  "customer_id" => 2,
+  "customer" =>  {
+    # customer data
+  },
+  "location_id" => 3,
+  "location" =>  {
+    # location data
+  }
+}
+```
+
+The `embed` method accepts one or more arguments as symbols or strings. It supports chaining and will merge the results of multiple calls.
+
+### Looping while results exist
+
+Issuing deletes while iterating over a collection resource can cause the pagination to shift resulting in unexpected behavior. Use `while_results` when you want to:
+
+- Consume messages from a queue, deleting each message after it has been processed.
+- Delete all resources in a collection that doesn't support a top-level DELETE method.
+
+For example:
+
+```ruby
+collection = client[:system][:messages]
+collection.while_results do |message|
+  # process message here...
+  collection[message['id']].delete!
+end
+```
+
+## Request body
+
+If the request body is a Hash, it will automatically be serialized as JSON. Otherwise, it is
+passed through untouched:
+
+```ruby
+# this:
+heartland[:some_collection].post :a => 1, :b => 2
+
+# is equivalent to this:
+heartland[:some_collection].post '{"a":1,"b":2}'
+```
+
+## Response
+
+```ruby
+response = heartland[:items][1].get
+
+response.status # Response status code as an Integer
+response.success? # true/false depending on whether 'status' indicates non-error
+response.body # Returns a HeartlandRetail::Client::Body object (see below)
+response.raw_body # Returns the raw response body as a string
+response[:some_key] # Returns the corresponding key from 'body'
+response.headers # Response headers as a Hash
+response.resource # Returns a Resource if the response included a "Location" header, else nil
+```
+
+### Response Body
+
+Given the following JSON response from the server:
+
+```javascript
+{
+  "id": 1234,
+  "custom": {
+    "color": "Blue"
+  }
+}
+```
+
+Here are the various ways you can access the data:
+
+```ruby
+body = response.body
+
+# Symbols and strings can be used interchangeably for keys
+body[:id]
+# => 1234
+
+body[:custom][:color]
+# => "Blue"
+
+body['custom']['color']
+# => "Blue"
+
+body.to_hash
+# => {"id"=>1234, "custom"=>{"color"=>"Blue"}}
+
+response.raw_body
+# => "{\"id\":1234,\"custom\":{\"color\":\"Blue\"}}"
+```
+
+## Bang variants
+
+All HTTP request methods have a bang variant that raises an exception on failure:
+
+```ruby
+response = heartland[:i_dont_exist].get
+response.status
+# => 404
+
+heartland[:i_dont_exist].get!
+# Raises HeartlandRetail::Client::RequestFailed exception
+
+# To access the response from the exception:
+begin
+  heartland[:i_dont_exist].get!
+rescue HeartlandRetail::Client::RequestFailed => error
+  puts error.response.status
+end
+# => 404
+
+```
+
+## Debugging
+
+```ruby
+# Log request/response trace to stdout
+client.debug = true
+
+# Or, log to a file
+client.debug = '/path/to/file.log'
+
+# Same values can be passed via :debug option to client constructor
+client = HeartlandRetail::Client.new '<url>', :debug => true
+```

data/Rakefile

@@ -0,0 +1,18 @@
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+Bundler.require(:default, :development)
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+desc "Start a console with a HeartlandRetail::Client instance"
+task :console do
+  require 'heartland/client'
+  require 'pry'
+  CLIENT = HeartlandRetail::Client.new(ENV['URI'])
+  CLIENT.auth :username => ENV['USER'], :password => ENV['PASSWORD']
+  Pry.start
+end