kounta_rest 0.1.7 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 508beffc4c5a0e5b96f76b9f3d9a26287c470203
-  data.tar.gz: 56a675417171a2e97486a00c1fe0d71b7dab88b8
+  metadata.gz: 863569524aae1949058648ddce027a8e28b39ad7
+  data.tar.gz: c778266f6a424de8d64f39c4bc26bf1578fe102d
 SHA512:
-  metadata.gz: 249606d473b6d0a8882b0c77b0547b3af84c9f2a5f2c0c53f7116e0c942000ddc678e5a7ecff99697e47e253069eda6f4308ad04833a6076122540c80918e12f
-  data.tar.gz: 8d405fcd1dd6a871137adebad28b3dff5a3675c49f50c1bc97e047c3f18efc34e21f5ec3205d14270fa26a92e30fbdf16079cbf7f56550e1284db406ba5274e4
+  metadata.gz: b556aa4720e769b097f636128006d2d06bc08bb4847bdee4e32c21bd5c6925d134d468e19177f11849e38fd8439d8f939f3c6be130bba581670f21db490c4991
+  data.tar.gz: 38b9b6295d83153c5a6fc720cd143babafe44bfaba220a3c81320116587bc3288ecc9e44ec536cd2e19f7216e5a55897c787037aa8daa9f09ee0fb5beb222e35

data/README.md

@@ -1,3 +1,5 @@
+[![Build Status](https://travis-ci.org/TandaHQ/Kounta.svg?branch=master)](https://travis-ci.org/TandaHQ/Kounta)
+
 # Kounta
 
 Allows easy access to the Kounta POS RESTful API.
@@ -6,63 +8,92 @@ Allows easy access to the Kounta POS RESTful API.
 
 Add this line to your application's Gemfile:
 
-    gem 'kounta_rest'
+```ruby
+gem 'kounta_rest'
+```
 
 And then execute:
 
-    $ bundle
+```
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install kounta_rest
+```
+$ gem install kounta_rest
+```
 
 ## Usage
 
-    require 'kounta'
-
-Then add your API details / other configuration options
-
-    Kounta.configure do |config|
-        config.client_id = "abcd1234"
-        config.client_secret = "abcd1234"
-        config.client_token = "abcd1234"
-        config.client_refresh_token = "abcd1234"
-    end
-
-You may also enable / disable logging (disabled by default)
-
-    config.enable_logging = true
-
-Use the gem by creating a Kounta company object:
-
-    company = Kounta::Company.new
+```ruby
+require 'kounta'
+```
+
+### Multi-legged OAuth
+
+If you've already got an OAuth access token, feel free to skip to API Client Setup.
+
+The Kounta API uses 3 legged OAuth2. Here's an example controller you can use to authenticate:
+
+```ruby
+class KountaSessionController
+  def new
+    redirect_to kounta_client.get_access_code_url
+  end
+
+  def create
+    token = kounta_client.get_access_token(params[:code])
+    kounta_client.company.sites # start loading data from the client
+  end
+
+  def kounta_client
+    @kounta_client ||= Kounta::REST::Client.new({
+      :redirect_url => YOUR_REDIRECT_URL,
+      :consumer => {
+        :key    => YOUR_CONSUMER_KEY,
+        :secret => YOUR_CONSUMER_SECRET,
+      },
+    })
+  end
+end
+```
+
+### API Client Setup
+
+Use the gem by creating a Kounta client:
+
+```ruby
+company = Kounta::REST::Client.new({
+  :consumer => {
+    :key    => YOUR_CONSUMER_KEY,
+    :secret => YOUR_CONSUMER_SECRET,
+  },
+  :access_token => YOUR_OAUTH_ACCESS_TOKEN
+}).company
+```
 
 This will automatically download data about the company associated with your authentication details.
 
 From here you can start to fetch relationships of that data, e.g. for all the sites belonging to your company
 
-    sites = company.sites
+```ruby
+sites = company.sites
+```
 
 For the products belonging to a site
 
-    sites.first.products
-
-Please see the test sweet for full details of these.
-
-### Console
-
-To aid debugging their is an interactive console. To get started, you'll need to create a "tokens.yml" file in the root of gem, like:
+```ruby
+sites.first.products
+```
 
-    client_id: abcd1234
-    client_secret: abcd1234
-    client_token: abcd1234
-    client_refresh_token: abcd1234
+Please see the test suite for full details of these.
 
-Then run:
+## Development
 
-    ruby console.rb
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-Get started by creating a Kounta::Company object (see above for detailed usage).
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 

data/lib/kounta/address.rb

@@ -1,18 +1,15 @@
 module Kounta
-
-	class Address < Kounta::Resource
-		property :company_id
-		property :people_id
-		property :lines
-		property :city
-		property :zone
-		property :postal_code
-		property :country
-
-		def resource_path
-			{people: people_id, addresses: id}
-		end
-
-	end
-
-end
+  class Address < Kounta::Resource
+    property :company_id
+    property :people_id
+    property :lines
+    property :city
+    property :zone
+    property :postal_code
+    property :country
+
+    def resource_path
+      { people: people_id, addresses: id }
+    end
+  end
+end

data/lib/kounta/break.rb

@@ -0,0 +1,6 @@
+module Kounta
+  class Break < Kounta::Resource
+    property :started_at
+    property :finished_at
+  end
+end

data/lib/kounta/category.rb

@@ -1,16 +1,13 @@
 module Kounta
-
-	class Category < Kounta::Resource
-		property :company_id
-		property :name
-		property :description
-		property :image
-		property :products
-
-		def resource_path
-			{companies: company_id, categories: id}
-		end		
-
-	end
-
-end
+  class Category < Kounta::Resource
+    property :company_id
+    property :name
+    property :description
+    property :image
+    property :products
+
+    def resource_path
+      { companies: company_id, categories: id }
+    end
+  end
+end

data/lib/kounta/company.rb

@@ -1,58 +1,67 @@
 module Kounta
+  class Company < Kounta::Resource
+    property :name
+    property :shipping_address
+    property :postal_address
+    property :addresses
+    property :business_number
+    property :contact_staff_member
+    property :image
+    property :website
+    property :currency
+    property :timezone
+    property :sites
+    property :registers
+    property :staff
+    property :email
+    property :webhooks
 
-	class Company < Kounta::Resource
+    has_one(:product, Kounta::Product, { company_id: :id }, proc { |klass, item_id| { companies: klass.id, products: item_id } })
+    has_one(:category, Kounta::Category, { company_id: :id }, proc { |klass, item_id| { companies: klass.id, categories: item_id } })
+    has_one(:customer, Kounta::Customer, { company_id: :id }, proc { |klass, item_id| { companies: klass.id, customers: item_id } })
+    has_one(:person, Kounta::Person, { company_id: :id }, proc { |klass, item_id| { companies: klass.id, people: item_id } })
+    has_one(:site, Kounta::Site, { company_id: :id }, proc { |klass, item_id| { companies: klass.id, sites: item_id } })
+    has_one(:price_list, Kounta::PriceList, { company_id: :id }, proc { |klass, item_id| { companies: klass.id, price_lists: item_id } })
+    has_one(:tax, Kounta::Tax, { company_id: :id }, proc { |klass, item_id| { companies: klass.id, taxes: item_id } })
+    has_one(:order, Kounta::Order, { company_id: :id }, proc { |klass, item_id| { companies: klass.id, orders: item_id } })
+    has_one(:register, Kounta::Register, { company_id: :id }, proc { |klass, item_id| { companies: klass.id, registers: item_id } })
+    has_one(:employee, Kounta::Staff, { company_id: :id }, proc { |klass, item_id| { companies: klass.id, staff: item_id } })
+    has_one(:webhook, Kounta::Webhook, { company_id: :id }, proc { |klass, item_id| { companies: klass.id, webhooks: item_id } })
 
-		property :name
-		property :shipping_address
-		property :postal_address
-		property :addresses
-		property :business_number
-		property :contact_staff_member
-		property :image
-		property :website
-		property :currency
-		property :timezone
-		property :sites
-		property :registers
-		property :email
+    has_many(:products, Kounta::Product, { company_id: :id }, proc { |klass| { companies: klass.id, products: nil } })
+    has_many(:categories, Kounta::Category, { company_id: :id }, proc { |klass| { companies: klass.id, categories: nil } })
+    has_many(:customers, Kounta::Customer, { company_id: :id }, proc { |klass| { companies: klass.id, customers: nil } })
+    has_many(:people, Kounta::Person, { company_id: :id }, proc { |klass| { companies: klass.id, people: nil } })
+    has_many(:sites, Kounta::Site, { company_id: :id }, proc { |klass| { companies: klass.id, sites: nil } })
+    has_many(:price_lists, Kounta::PriceList, { company_id: :id }, proc { |klass| { companies: klass.id, price_lists: nil } })
+    has_many(:taxes, Kounta::Tax, { company_id: :id }, proc { |klass| { companies: klass.id, taxes: nil } })
+    has_many(:orders, Kounta::Order, { company_id: :id }, proc { |klass| { companies: klass.id, orders: nil } })
+    has_many(:registers, Kounta::Register, { company_id: :id }, proc { |klass| { companies: klass.id, registers: nil } })
+    has_many(:employees, Kounta::Staff, { company_id: :id }, proc { |klass| { companies: klass.id, staff: nil } })
+    has_many(:shifts, Kounta::Shift, { company_id: :id }, proc { |klass, date| { companies: klass.id, shifts: Kounta.format_date(date) } })
+    has_many(:shifts_since, Kounta::Shift, { company_id: :id },
+             proc { |klass, date| { companies: klass.id, shifts: nil, since: Kounta.format_date(date) } })
+    has_many(:webhooks, Kounta::Webhook, { company_id: :id }, proc { |klass, _item_id| { companies: klass.id, webhooks: nil } })
 
-		has_one :product, Kounta::Product, {:company_id => :id}, lambda { |klass, item_id| {companies: klass.id, products: item_id} }
-		has_one :category, Kounta::Category, {:company_id => :id}, lambda { |klass, item_id| {companies: klass.id, categories: item_id} }
-		has_one :customer, Kounta::Customer, {:company_id => :id}, lambda { |klass, item_id| {companies: klass.id, customers: item_id} }
-		has_one :person, Kounta::Person, {:company_id => :id}, lambda { |klass, item_id| {companies: klass.id, people: item_id} }
-		has_one :site, Kounta::Site, {:company_id => :id}, lambda { |klass, item_id| {companies: klass.id, sites: item_id} }
-		has_one :price_list, Kounta::PriceList, {:company_id => :id}, lambda { |klass, item_id| {companies: klass.id, price_lists: item_id} }
-		has_one :tax, Kounta::Tax, {:company_id => :id}, lambda { |klass, item_id| {companies: klass.id, taxes: item_id} }
-		has_one :order, Kounta::Order, {:company_id => :id}, lambda { |klass, item_id| {companies: klass.id, orders: item_id} }
-		has_one :register, Kounta::Register, {:company_id => :id}, lambda { |klass, item_id| {companies: klass.id, registers: item_id} }
+    has_many_in_time_range(:orders_in_time_range, Kounta::Order, { company_id: :id }, proc { |klass| { companies: klass.id, orders: nil } })
 
-		has_many :products, Kounta::Product, {:company_id => :id}, lambda { |klass| {companies: klass.id, products: nil} }
-		has_many :categories, Kounta::Category, {:company_id => :id}, lambda { |klass| {companies: klass.id, categories: nil} }
-		has_many :customers, Kounta::Customer, {:company_id => :id}, lambda { |klass| {companies: klass.id, customers: nil} }
-		has_many :people, Kounta::Person, {:company_id => :id}, lambda { |klass| {companies: klass.id, people: nil} }
-		has_many :sites, Kounta::Site, {:company_id => :id}, lambda { |klass| {companies: klass.id, sites: nil} }
-		has_many :price_lists, Kounta::PriceList, {:company_id => :id}, lambda { |klass| {companies: klass.id, price_lists: nil} }
-		has_many :taxes, Kounta::Tax, {:company_id => :id}, lambda { |klass| {companies: klass.id, taxes: nil} }
-		has_many :orders, Kounta::Order, {:company_id => :id}, lambda { |klass| {companies: klass.id, orders: nil} }
-		has_many :registers, Kounta::Register, {:company_id => :id}, lambda { |klass| {companies: klass.id, registers: nil} }
+    def initialize(client, hash = {})
+      @client = client
 
-		def initialize(hash={})
-			if hash.empty?
-				response = client.perform({:companies => "me"}, :get).parsed
-				super(response)
-			else
-				super(hash)
-			end
-		end
+      if hash.empty?
+        response = client.perform({ companies: 'me' }, :get).parsed
+        super(response)
+      else
+        super(hash)
+      end
+    end
 
-		def base_price_list
-			client.object_from_response(Kounta::PriceList, :get, {companies: id, price_lists: 'base'})
-		end
+    def base_price_list
+      client.object_from_response(Kounta::PriceList, :get, companies: id, price_lists: 'base')
+    end
 
-		def resource_path
-			{companies: id}
-		end
-
-	end
-
-end
+    def resource_path
+      { companies: id }
+    end
+  end
+end

data/lib/kounta/customer.rb

@@ -1,36 +1,37 @@
 module Kounta
+  class Customer < Kounta::Resource
+    property :company_id
+    property :people_id
+    property :first_name
+    property :last_name
+    property :email
+    property :primary_email_address
+    property :description
+    property :email_addresses
+    property :phone
+    property :mobile
+    property :fax
+    property :shipping_address
+    property :postal_address
+    property :addresses
+    property :image
+    property :tags
 
-	class Customer < Kounta::Resource
-		property :company_id
-		property :people_id
-		property :first_name
-		property :last_name
-		property :email
-		property :primary_email_address
-		property :description
-		property :email_addresses
-		property :phone
-		property :mobile
-		property :fax
-		property :shipping_address
-		property :postal_address
-		property :addresses
-		property :image
-		property :tags
+    has_one(:address, Kounta::Address, { company_id: :company_id },
+            proc { |klass, item_id| { companies: klass.company_id, customers: klass.id, addresses: item_id } })
+    has_one(:order, Kounta::Order, { company_id: :company_id },
+            proc { |klass, item_id| { companies: klass.company_id, customers: klass.id, orders: item_id } })
+    has_many(:addresses, Kounta::Address, { company_id: :company_id },
+             proc { |klass| { companies: klass.company_id, customers: klass.id, addresses: nil } })
+    has_many(:orders, Kounta::Order, { company_id: :company_id },
+             proc { |klass| { companies: klass.company_id, customers: klass.id, orders: nil } })
 
-		has_one :address, Kounta::Address, {:company_id => :company_id}, lambda { |klass, item_id| {companies: klass.company_id, customers: klass.id, addresses: item_id} }
-		has_one :order, Kounta::Order, {:company_id => :company_id}, lambda { |klass, item_id| {companies: klass.company_id, customers: klass.id, orders: item_id} }
-		has_many :addresses, Kounta::Address, {:company_id => :company_id}, lambda { |klass| {companies: klass.company_id, customers: klass.id, addresses: nil} }
-		has_many :orders, Kounta::Order, {:company_id => :company_id}, lambda { |klass| {companies: klass.company_id, customers: klass.id, orders: nil} }
+    def name
+      "#{first_name} #{last_name}"
+    end
 
-		def name
-			"#{first_name} #{last_name}"
-		end
-
-		def resource_path
-			{companies: company_id, customers: id}
-		end
-
-	end
-
-end
+    def resource_path
+      { companies: company_id, customers: id }
+    end
+  end
+end

data/lib/kounta/errors.rb

@@ -1,8 +1,9 @@
 module Kounta
-	module Errors
-		class KountaError < StandardError; end
-		class MissingOauthDetails < KountaError; end
-		class UnknownResourceAttribute < KountaError; end
-		class APIError < KountaError; end
-	end
-end
+  module Errors
+    class KountaError < StandardError; end
+    class MissingOauthDetails < KountaError; end
+    class UnknownResourceAttribute < KountaError; end
+    class APIError < KountaError; end
+    class RequestError < KountaError; end
+  end
+end

data/lib/kounta/inventory.rb

@@ -1,8 +1,6 @@
 module Kounta
-
-	class Inventory < Kounta::Resource
-		property :company_id
-		property :stock
-	end
-
-end
+  class Inventory < Kounta::Resource
+    property :company_id
+    property :stock
+  end
+end

data/lib/kounta/line.rb

@@ -1,24 +1,21 @@
 module Kounta
+  class Line < Kounta::Resource
+    property :company_id
+    property :order_id
+    property :product_id
+    property :number
+    property :quantity
+    property :notes
+    property :price_variation
+    property :product
+    property :unit_price
+    property :unit_tax
+    property :modifiers
 
-	class Line < Kounta::Resource
-		property :company_id
-		property :order_id
-		property :product_id
-		property :number
-		property :quantity
-		property :notes
-		property :price_variation
-		property :product
-		property :unit_price
-		property :unit_tax
-		property :modifiers
+    coerce_key :product, Kounta::Product
 
-		coerce_key :product, Kounta::Product
-
-		def resource_path
-			{companies: company_id, orders: order_id, lines: id}
-		end
-
-	end
-
-end
+    def resource_path
+      { companies: company_id, orders: order_id, lines: id }
+    end
+  end
+end

data/lib/kounta/order.rb

@@ -1,51 +1,47 @@
 module Kounta
-
-	class Order < Kounta::Resource
-		property :company_id
-		property :status
-		property :customer
-		property :customer_id
-		property :register_id
-		property :site_id
-		property :lines
-		property :payments
-		property :callback_uri
-		property :placed_at
-		property :fulfil_at
-		property :notes
-		property :total
-		property :paid
-		property :product
-		property :sale_number
-		property :price_variation
-		property :lock
-
-		coerce_key :lines, Kounta::Line
-		coerce_key :payments, Kounta::Payment
-
-		def initialize(hash={})
-			super(hash)
-			self.payments ||= []
-			self.lines ||= []
-		end
-
-		def to_hash
-			returning = {}
-			returning[:lines] = lines.map {|line| line.to_hash } if lines && lines.length > 0
-			returning[:payments] = payments.map {|payment| payment.to_hash } if payments && payments.length > 0
-			super(returning)
-		end
-
-		def resource_path
-			{companies: company_id, orders: id}
-		end
-
-		# we manually map these
-		def ignored_properties
-			super([:lock, :site_id])
-		end
-
-	end
-
+  class Order < Kounta::Resource
+    property :company_id
+    property :status
+    property :customer
+    property :customer_id
+    property :register_id
+    property :site_id
+    property :lines
+    property :payments
+    property :callback_uri
+    property :placed_at
+    property :fulfil_at
+    property :notes
+    property :total
+    property :paid
+    property :product
+    property :sale_number
+    property :price_variation
+    property :lock
+
+    coerce_key :lines, Kounta::Line
+    coerce_key :payments, Kounta::Payment
+
+    def initialize(hash = {})
+      super(hash)
+      self.payments ||= []
+      self.lines ||= []
+    end
+
+    def to_hash
+      returning = {}
+      returning[:lines] = lines.map(&:to_hash) if lines && !lines.empty?
+      returning[:payments] = payments.map(&:to_hash) if payments && !payments.empty?
+      super(returning)
+    end
+
+    def resource_path
+      { companies: company_id, orders: id }
+    end
+
+    # we manually map these
+    def ignored_properties
+      super(%i[lock site_id])
+    end
+  end
 end
-

data/lib/kounta/payment.rb

@@ -1,18 +1,15 @@
 module Kounta
-
-	class Payment < Kounta::Resource
-		property :company_id
-		property :order_id
-		property :method_id
-		property :amount
-		property :ref
-		property :method
-		property :number
-
-		def resource_path
-			{companies: company_id, orders: order_id, payments: id}
-		end
-
-	end
-
-end
+  class Payment < Kounta::Resource
+    property :company_id
+    property :order_id
+    property :method_id
+    property :amount
+    property :ref
+    property :method
+    property :number
+
+    def resource_path
+      { companies: company_id, orders: order_id, payments: id }
+    end
+  end
+end

data/lib/kounta/person.rb

@@ -1,27 +1,24 @@
 module Kounta
+  class Person < Kounta::Resource
+    property :company_id
+    property :customer_id
+    property :staff_id
+    property :first_name
+    property :last_name
+    property :primary_email_address
+    property :email_addresses
+    property :shipping_address
+    property :postal_address
+    property :addresses
+    property :phone_numbers
+    property :image
 
-	class Person < Kounta::Resource
-		property :company_id
-		property :customer_id
-		property :staff_id
-		property :first_name
-		property :last_name
-		property :primary_email_address
-		property :email_addresses
-		property :shipping_address
-		property :postal_address
-		property :addresses
-		property :phone_numbers
-		property :image
+    def name
+      "#{first_name} #{last_name}"
+    end
 
-		def name
-			"#{first_name} #{last_name}"
-		end
-
-		def resource_path
-			{companies: company_id, people: id}
-		end
-
-	end
-
-end
+    def resource_path
+      { companies: company_id, people: id }
+    end
+  end
+end