lightspeed_pos 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f479289d48eb83582ea0f30e93bf82644e0a5cad
+  data.tar.gz: a0b8758eaeeaa5f7f6f044cc9bdd3689156f6d03
+SHA512:
+  metadata.gz: be2f7ba8a83b024b43def375f084ab63f695087651563e690f4ec235c453b1f19d54cf0e938f5fd31a04fb83e110d8c0fde4c5006bac7c405f6da6c987bc9891
+  data.tar.gz: e04d5d7c4dabf225688e79e5bf071cd86c371ec5dd2fffea4d88721970ceeb4558cf3b996a24b42ebaf3a3f9be15cd2d72ee3b5dec07011bfc38a4d37bbeaa41

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.env

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,69 @@
+AlignHash:
+  EnforcedLastArgumentHashStyle: always_ignore
+
+AlignParameters:
+  Enabled: false
+
+LineLength:
+  Max: 180
+
+ClassLength:
+  Enabled: true
+  Severity: refactor
+  Max: 300
+
+MethodLength:
+  Enabled: true
+  Max: 30
+  Severity: refactor
+
+CyclomaticComplexity:
+  Max: 10
+  Severity: refactor
+
+EndAlignment:
+  Enabled: false
+
+StringLiterals:
+  Enabled: false
+
+Documentation:
+  Enabled: false
+
+PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%w': '{}'
+
+MethodDefParentheses:
+  Enabled: false
+
+PredicateName:
+  NamePrefixBlacklist:
+    - is_
+    - have_
+
+IndentHash:
+  EnforcedStyle: consistent
+
+# breaks using if blocks with assignments
+IndentationWidth:
+  Enabled: false
+
+CaseIndentation:
+  IndentWhenRelativeTo: end
+
+FormatString:
+  Enabled: false
+
+ActionFilter:
+  Enabled: false
+
+# different methods calls that do exactly the same thing are a smell, regardless of semantics
+SignalException:
+  EnforcedStyle: only_raise
+
+DoubleNegation:
+  Enabled: false
+
+TrailingComma:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 2.2.2
+  - 2.1.6
+script:
+  - 'bundle exec rspec spec'
+  - 'bundle exec rubocop'
+cache: bundler
+sudo: false

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Ryan Bigg
+
+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.markdown

@@ -0,0 +1,98 @@
+# Lightspeed POS
+
+[![Build Status](https://travis-ci.org/radar/lightspeed-pos.svg?branch=master)](https://travis-ci.org/radar/lightspeed-pos)
+[![Code Climate](https://codeclimate.com/github/radar/lightspeed-pos/badges/gpa.svg)](https://codeclimate.com/github/radar/lightspeed-pos)
+
+
+An _unofficial_ gem for interacting with [Lightspeed's Point of Sale API](http://www.lightspeedpos.com/retail/help/developers/api/basics/). Works with API keys for the time being.
+
+Most definitely not production ready yet, but you can help by submitting pull requests!
+
+## Getting Started
+
+First, intialize a new client:
+
+```ruby
+client = Lightspeed::Client.new(api_key: "YOUR_API_KEY_HERE")
+```
+
+**OR** you may also choose to pass through an OAuth access token if you have one:
+
+```ruby
+client = Lightspeed::Client.new(oauth_token: "YOUR_ACCESS_TOKEN_HERE")
+```
+
+Next, make a request for your accounts:
+
+```ruby
+accounts = client.accounts
+```
+
+Pick the account you want to use, and then start using it:
+
+```ruby
+account = accounts.first
+account.items # This will return the first 100 items from the account
+```
+
+## Account Resources
+
+Account resources share a common API. Account resources that are currently supported by this library are:
+
+* Categories
+* Items
+
+To work with account resources, you first need to fetch an account. The examples below are for items, but will also work with other types listed above.
+
+### List
+
+You can fetch a list of items with this:
+
+```ruby
+account.items.all
+```
+
+### Show
+
+You can fetch a particular item by its ID by doing this:
+
+```ruby
+account.items.find(1)
+```
+
+### Create
+
+You can create a particular item by calling `create`:
+
+```ruby
+account.items.create({
+  description: "Onesie"
+})
+```
+
+### Update
+
+You can update a particular item by calling `update`, passing that item's ID and providing a list of attributes to update:
+
+```ruby
+account.items.update(1, {
+  description: "Onesie"
+})
+```
+
+This method isn't available on items themselves because I couldn't work out how to share the account ID easily there.
+
+### Destroy
+
+You can destroy a particular item by calling `destroy` and passing that item's ID:
+
+```ruby
+account.items.destroy(1)
+```
+
+For the `Items` resource, this is aliased to `archive`:
+
+```ruby
+account.items.archive(1)
+```
+

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "lightspeed/pos"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/lightspeed/account.rb

@@ -0,0 +1,48 @@
+require 'lightspeed/base'
+require 'lightspeed/categories'
+require 'lightspeed/items'
+require 'lightspeed/item_matrices'
+
+module Lightspeed
+  class Account < Lightspeed::Base
+    attr_accessor :id, :name, :link
+
+    def client
+      owner
+    end
+
+    def items
+      item_proxy
+    end
+
+    def categories
+      category_proxy
+    end
+
+    def item_matrices
+      item_matrices_proxy
+    end
+
+    def instantiate(*args)
+      client.instantiate(self, *args)
+    end
+
+    private
+
+    def self.id_field
+      "accountID"
+    end
+
+    def item_proxy
+      @item_proxy ||= Lightspeed::Items.new(self)
+    end
+
+    def category_proxy
+      @category_proxy ||= Lightspeed::Categories.new(self)
+    end
+
+    def item_matrices_proxy
+      @item_matrices_proxy ||= Lightspeed::ItemMatrices.new(self)
+    end
+  end
+end

data/lib/lightspeed/account_resources.rb

@@ -0,0 +1,103 @@
+require 'active_support/core_ext/string'
+
+module Lightspeed
+  class AccountResources
+    attr_accessor :account
+
+    def initialize(account)
+      @account = account
+    end
+
+    def all
+      response = get
+      account.instantiate(response[resource_name], Lightspeed.const_get(resource_name))
+    end
+
+    def find(id)
+      params = { "#{resource_name.camelize(:lower)}ID" => id }
+      response = get(params: params)
+      if response[resource_name]
+        resource_class.new(account, response[resource_name])
+      else
+        raise Lightspeed::Errors::NotFound, "Could not find a #{resource_name} by #{params.inspect}"
+      end
+    end
+
+    def create(attributes = {})
+      craft_instance(post(body: attributes.to_json))
+    end
+
+    def update(id, attributes = {})
+      craft_instance(put(id, body: attributes.to_json))
+    end
+
+    def destroy(id)
+      craft_instance(delete(id))
+    end
+
+    private
+
+    def craft_instance(response)
+      resource_class.new(client, response[resource_name])
+    end
+
+    def client
+      account.client
+    end
+
+    def resource_class
+      Lightspeed.const_get(resource_name)
+    end
+
+    def resource_name
+      self.class.resource_name
+    end
+
+    def get(params: nil)
+      request = client.request(
+        method: :get,
+        path: collection_path,
+        params: params
+      )
+      request.perform
+    end
+
+    def post(body:)
+      request = client.request(
+        method: :post,
+        path: collection_path,
+        body: body
+      )
+      request.perform
+    end
+
+    def put(id, body:)
+      request = client.request(
+        method: :put,
+        path: item_path(id),
+        body: body,
+      )
+      request.perform
+    end
+
+    def delete(id)
+      request = client.request(
+        method: :delete,
+        path: item_path(id)
+      )
+      request.perform
+    end
+
+    def base_path
+      "/Account/#{account.id}/#{self.class.resource_name}"
+    end
+
+    def collection_path
+      base_path + ".json"
+    end
+
+    def item_path(id)
+      base_path + "/#{id}.json"
+    end
+  end
+end

data/lib/lightspeed/base.rb

@@ -0,0 +1,17 @@
+module Lightspeed
+  class Base
+    attr_accessor :id, :owner
+
+    def initialize(owner, data = {})
+      @owner = owner
+      self.id = data.delete(self.class.id_field)
+      data.each do |k, v|
+        send("#{k}=", v)
+      end
+    end
+
+    def inspect
+      "#<#{self.class.name} id=#{id}>"
+    end
+  end
+end

data/lib/lightspeed/categories.rb

@@ -0,0 +1,10 @@
+require 'lightspeed/category'
+require 'lightspeed/account_resources'
+
+module Lightspeed
+  class Categories < Lightspeed::AccountResources
+    def self.resource_name
+      "Category"
+    end
+  end
+end

data/lib/lightspeed/category.rb

@@ -0,0 +1,10 @@
+module Lightspeed
+  class Category < Base
+    attr_accessor :name, :nodeDepth, :fullPathName, :leftNode, :rightNode, :timeStamp, :parentID,
+      :createTime
+
+    def self.id_field
+      "categoryID"
+    end
+  end
+end

data/lib/lightspeed/client.rb

@@ -0,0 +1,45 @@
+require 'lightspeed/account'
+require 'lightspeed/request'
+
+module Lightspeed
+  class Client
+    attr_accessor :api_key, :oauth_token
+
+    def initialize(api_key: nil, oauth_token: nil)
+      @api_key = api_key
+      @oauth_token = oauth_token
+    end
+
+    def request(**args)
+      Lightspeed::Request.new(self, **args)
+    end
+
+    # Returns a list of accounts that you have access to.
+    def accounts
+      request = request(method: :get, path: "/Account.json")
+      response = request.perform
+      instantiate(response["Account"], Lightspeed::Account)
+    end
+
+    # Instantiates a bunch of records from Lightspeed into their proper classes.
+    def instantiate(owner = self, records, klass)
+      records = splat(records)
+      records.map do |record|
+        klass.new(owner, record)
+      end
+    end
+
+    private
+
+    # Converts a thing to an Array unless it is already.
+    # Unfortunately necessary because Lightspeed's API may return an object,
+    # or an array of objects.
+    #
+    # The compact is becuase it may return nothing at all.
+    # In the example of fetching categories resource where there are no categories,
+    # response["Category"] will not be present.
+    def splat(thing)
+      (thing.is_a?(Array) ? thing : [thing]).compact
+    end
+  end
+end

data/lib/lightspeed/errors.rb

@@ -0,0 +1,8 @@
+module Lightspeed
+  module Errors
+    class BadRequest < Exception; end # 400
+    class Unauthorized < Exception; end # 401
+    class NotFound < Exception; end # 404
+    class InternalServerError < Exception; end # 500
+  end
+end

data/lib/lightspeed/item.rb

@@ -0,0 +1,26 @@
+require 'lightspeed/base'
+
+module Lightspeed
+  class Item < Lightspeed::Base
+    attr_accessor :systemSku, :defaultCost, :avgCost, :discountable, :tax,
+      :archived, :itemType, :description, :modelYear, :upc, :ean, :customSku,
+      :manufacturerSku, :createTime, :timeStamp,
+
+      # Association keys
+      :categoryID, :taxClassID, :departmentID, :itemMatrixID, :manufacturerID, :seasonID,
+      :defaultVendorID, :itemECommerceID,
+
+      # Embedded
+      :ItemMatrix, :ItemAttributes, :ItemShops, :Prices, :Note
+
+    def self.id_field
+      "itemID"
+    end
+
+    # FUNFACT: ItemMatrix data is returned during an `update` request,
+    # but not during a `find` request.
+    def item_matrix
+      @ItemMatrix ||= owner.item_matrices.find(itemMatrixID) # rubocop:disable VariableName
+    end
+  end
+end

data/lib/lightspeed/item_matrices.rb

@@ -0,0 +1,10 @@
+require 'lightspeed/item_matrix'
+require 'lightspeed/account_resources'
+
+module Lightspeed
+  class ItemMatrices < AccountResources
+    def self.resource_name
+      "ItemMatrix"
+    end
+  end
+end

data/lib/lightspeed/item_matrix.rb

@@ -0,0 +1,17 @@
+module Lightspeed
+  class ItemMatrix < Lightspeed::Base
+    attr_accessor :description, :tax, :defaultCost, :itemType, :modelYear, :archived,
+      :timeStamp
+
+    # Association keys
+    attr_accessor :itemAttributeSetID, :manufacturerID, :categoryID, :defaultVendorID,
+      :taxClassID, :seasonID, :departmentID, :itemECommerceID
+
+    # Embedded
+    attr_accessor :Prices
+
+    def self.id_field
+      "itemMatrixID"
+    end
+  end
+end

data/lib/lightspeed/items.rb

@@ -0,0 +1,12 @@
+require 'lightspeed/item'
+require 'lightspeed/account_resources'
+
+module Lightspeed
+  class Items < Lightspeed::AccountResources
+    alias_method :archive, :destroy
+
+    def self.resource_name
+      "Item"
+    end
+  end
+end

data/lib/lightspeed/request.rb

@@ -0,0 +1,55 @@
+module Lightspeed
+  class Request
+    attr_accessor :raw_request
+
+    def self.base_url
+      "https://api.merchantos.com/API"
+    end
+
+    def initialize(client, method:, path:, params: nil, body: nil)
+      @raw_request = Typhoeus::Request.new(
+        self.class.base_url + path,
+        method: method,
+        body: body,
+        params: params
+      )
+
+      if client.oauth_token
+        @raw_request.options[:headers].merge!(
+          "Authorization" => "OAuth #{client.oauth_token}"
+        )
+      end
+
+      @raw_request.options[:userpwd] = "#{client.api_key}:apikey" if client.api_key
+    end
+
+    def perform
+      response = raw_request.run
+      if response.code == 200
+        handle_success(response)
+      else
+        handle_error(response)
+      end
+    end
+
+    private
+
+    def handle_success(response)
+      JSON.parse(response.body)
+    end
+
+    def handle_error(response)
+      data = JSON.parse(response.body)
+      error = case response.code
+      when 400
+        Lightspeed::Errors::BadRequest
+      when 401
+        Lightspeed::Errors::Unauthorized
+      when 500
+        Lightspeed::Errors::InternalServerError
+      end
+
+      raise error.new(data["message"]) if error # rubocop:disable RaiseArgs
+    end
+  end
+end

data/lib/lightspeed/version.rb

@@ -0,0 +1,3 @@
+module Lightspeed
+  VERSION = "0.1.0"
+end

data/lib/lightspeed_pos.rb

@@ -0,0 +1,9 @@
+require 'typhoeus'
+require 'json'
+require 'pry'
+
+module Lightspeed
+end
+
+require 'lightspeed/client'
+require 'lightspeed/errors'

data/lightspeed_pos.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lightspeed/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "lightspeed_pos"
+  spec.version       = Lightspeed::VERSION
+  spec.authors       = ["Ryan Bigg"]
+  spec.email         = ["git@ryanbigg.com"]
+
+  spec.summary       = "A gem for interacting with Lightspeed's Point of Sale system"
+  spec.description   = "A gem for interacting with Lightspeed's Point of Sale system"
+  spec.homepage      = "https://github.com/radar/lightspeed_pos"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.license       = "MIT"
+
+  spec.add_dependency "typhoeus", "0.7.2"
+  spec.add_dependency "activesupport", "4.2.3"
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "3.2.0"
+  spec.add_development_dependency "webmock", "1.21.0"
+  spec.add_development_dependency "vcr", "2.9.3"
+
+  spec.add_development_dependency "pry"
+end

metadata

@@ -0,0 +1,181 @@
+--- !ruby/object:Gem::Specification
+name: lightspeed_pos
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ryan Bigg
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-07-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.7.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.7.2
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.2.3
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.21.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.21.0
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.9.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.9.3
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+description: A gem for interacting with Lightspeed's Point of Sale system
+email:
+- git@ryanbigg.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.markdown
+- Rakefile
+- bin/console
+- bin/setup
+- lib/lightspeed/account.rb
+- lib/lightspeed/account_resources.rb
+- lib/lightspeed/base.rb
+- lib/lightspeed/categories.rb
+- lib/lightspeed/category.rb
+- lib/lightspeed/client.rb
+- lib/lightspeed/errors.rb
+- lib/lightspeed/item.rb
+- lib/lightspeed/item_matrices.rb
+- lib/lightspeed/item_matrix.rb
+- lib/lightspeed/items.rb
+- lib/lightspeed/request.rb
+- lib/lightspeed/version.rb
+- lib/lightspeed_pos.rb
+- lightspeed_pos.gemspec
+homepage: https://github.com/radar/lightspeed_pos
+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.8
+signing_key: 
+specification_version: 4
+summary: A gem for interacting with Lightspeed's Point of Sale system
+test_files: []