unleashed_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 48d7dedd825a06c4828fe101d25ac82f408863fe4d930cf5e6eab932198b59c0
+  data.tar.gz: 670cf5a6ca7321183ee009956be29d0c431d83c4aa6762db51586fb64a008666
+SHA512:
+  metadata.gz: a2688e2089c72b7de1be4a6e7b04f029beb10d2913d844b4b2defa98992ca98ba57be6bc280c3115ebad4bdf6a1ce57c5b4d8986f93f1e80ca717746dc12711d
+  data.tar.gz: 669bfb667c5ba5949a6323d615b79bcb8fe24a0de859163f3042f07b0c1b83026049db46e3000ec0692832bb706105b4b64e8935f42bb878092b7e444bebe129

data/.gitignore

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

data/.rspec_status

@@ -0,0 +1,5 @@
+example_id                             | status | run_time        |
+-------------------------------------- | ------ | --------------- |
+./spec/unleashed_client_spec.rb[1:1:1] | failed | 0.0001 seconds  |
+./spec/unleashed_client_spec.rb[1:1:2] | failed | 0.00006 seconds |
+./spec/unleashed_client_spec.rb[1:1:3] | failed | 0.00005 seconds |

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.1.4

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# Change Log
+
+All changes to this project will be documented in this file.
+
+## [0.1.0] - September 13th, 2020
+- Project created;

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at marko.manojlovic.bg@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in unleashed_client.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"

data/Gemfile.lock

@@ -0,0 +1,46 @@
+PATH
+  remote: .
+  specs:
+    unleashed_client (0.1.0)
+      httparty (~> 0.18.0, >= 0.18.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    dotenv (2.7.6)
+    httparty (0.18.1)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2020.0512)
+    minitest (5.14.2)
+    multi_xml (0.6.0)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  dotenv (~> 2.7, >= 2.7.6)
+  minitest (~> 5.0)
+  rake (~> 12.0)
+  rspec
+  unleashed_client!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Marko Manojlovic
+
+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,119 @@
+# Unleashed
+
+![](https://res.cloudinary.com/manoylo/image/upload/v1600048806/unleashed-logo_s2plij.svg)
+
+A Ruby wrapper for [Unleashed](https://www.unleashedsoftware.com/)
+
+## Documentation
+The documentation for Unleashed API can be found [here](https://apidocs.unleashedsoftware.com)
+
+## Supported Resources
+This library supports the following resources:
+* [SalesOrders](https://apidocs.unleashedsoftware.com/SalesOrders)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'unleashed_client'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install unleashed_client
+
+## Getting Started
+
+### 1. Unleashed API key and API ID
+
+Before you can use the gem, you will have to register and get your API key and API ID. Check out [Unleashed get started page](https://apidocs.unleashedsoftware.com/) for more information.
+
+### 2. Set your ENV
+Set your API_KEY and API_ID as your environment variables. If you're managing your environment variables [dotenv](https://github.com/bkeepers/dotenv) add API_KEY=your_key and API_ID=your_id to your .env file, or if you're using something like [Figaro](https://github.com/laserlemon/figaro) set your API_KEY: your_key and your API_ID: your_id.
+
+### 3. Use it
+```ruby
+require 'unleashed_client'
+
+@client = UnleashedClient::SalesOrder.new(api_key: ENV['API_KEY'], api_id: ENV['API_ID'])
+```
+
+### Get total number of pages
+This is useful if you need to iterate over all pages and get all the data:
+
+```ruby
+response = @client.get_number_of_pages
+pages = response["Pagination"]["NumberOfPages"]
+```
+
+### Get the first 200 sales orders
+Returns the first 200 sales orders because page number 1 is the default:
+
+```ruby
+response = @client.get_first_200
+items = response["Items"]
+```
+
+### Get sales orders from a specific page
+```ruby
+your_page_number = 2
+response = @client.get_orders_from_page(page_number: your_page_number)
+items = response["Items]
+```
+
+Example usage:
+You can combine get_orders_from_page with get_number_of_pages. This will allow you to loop through all available pages and get the data (for example, if you are creating records in your local database):
+
+```ruby
+require 'unleashed_client'
+
+@client = UnleashedClient::SalesOrder.new(api_key: ENV['API_KEY'], api_id: ENV['API_ID'])
+
+response = @client.get_number_of_pages
+number_of_pages = response["Pagination"]["NumberOfPages"]
+
+number_of_pages.downto(1).each do |i|
+    items = @client.get_orders_from_page(page_number: i)
+    # do stuff with items
+end
+```
+
+### Get sales orders details
+Returns details of a particular sales order using sales order guid value (ex guid: E6E8163F-6911-40e9-B740-90E5A0A3A996)
+
+```ruby
+your_guid = "E6E8163F-6911-40e9-B740-90E5A0A3A996"
+response = @client.get_details(guid: your_guid)
+
+# response["Guid"] => "E6E8163F-6911-40e9-B740-90E5A0A3A996"
+# response["OrderNumber"] => "SO-xxx"
+# ...
+```
+
+## TODO
+* Add better tests wth Rspec;
+
+What has to be added for SalesOrders resource:
+* creating new sales orders;
+* complete a sales order;
+* update a sales order;
+
+Other resources to be added:
+* [Customers](https://apidocs.unleashedsoftware.com/Customers);
+* [Products](https://apidocs.unleashedsoftware.com/Products);
+* [PurchaseOrders](https://apidocs.unleashedsoftware.com/Purchases);
+* [SalesPersons](https://apidocs.unleashedsoftware.com/SalesPersons);
+* [SalesPersons](https://apidocs.unleashedsoftware.com/SalesPersons);
+* [SalesShipments](https://apidocs.unleashedsoftware.com/SalesShipments);
+* [StockAdjustments](https://apidocs.unleashedsoftware.com/StockAdjustments);
+* [WarehouseStockTransfers](https://apidocs.unleashedsoftware.com/WarehouseStockTransfers);
+
+## Author
+* Marko Manojlovic <marko.manojlovic.bg@gmail.com>
+* [https://manoylo.me](https:/manoylo.me)
+* [LinkedIn](https://www.linkedin.com/in/marko-manojlovic-mm/)

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "unleashed_client"
+
+# 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(__FILE__)

data/bin/setup

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

data/lib/http/auth.rb

@@ -0,0 +1,9 @@
+require 'openssl'
+require 'base64'
+
+class Auth
+  def self.get_signature(api_key:, query:)
+    data = query ? query.force_encoding('UTF-8') : ''
+    Base64.encode64(OpenSSL::HMAC.digest(OpenSSL::Digest.new('sha256'), api_key, data)).strip
+  end
+end

data/lib/http/http_client.rb

@@ -0,0 +1,45 @@
+require_relative 'auth'
+require 'httparty'
+
+module HTTP
+  class Client
+    API_URL = "https://api.unleashedsoftware.com"
+
+    class << self
+      def get(api_id:, api_key:, query:, unleashed_model:)
+        headers = generate_signature_and_headers(api_key: api_key, api_id: api_id, query: query)
+        
+        url = "#{API_URL}/#{unleashed_model}"
+        HTTParty.get(url, headers: headers)
+      end
+
+      def get_with_guid(api_id:, api_key:, query:, unleashed_model:, guid:)
+        headers = generate_signature_and_headers(api_key: api_key, api_id: api_id, query: query)
+
+        url = "#{API_URL}/#{unleashed_model}/#{guid}"
+        HTTParty.get(url, headers: headers)
+      end
+
+      def get_from_page(api_id:, api_key:, query:, unleashed_model:, page_number:)
+        headers = generate_signature_and_headers(api_key: api_key, api_id: api_id, query: query)
+
+        url = "#{API_URL}/#{unleashed_model}/Page/#{page_number}"
+        response = HTTParty.get(url, headers: headers)
+        response["Items"]
+      end
+
+      private
+
+      def generate_signature_and_headers(api_key:, api_id:, query:)
+        signature = Auth.get_signature(api_key: api_key, query: query)
+
+        {
+          "Content-Type" => "application/json",
+          "Accept" => "application/json",
+          "api-auth-id" => api_id,
+          "api-auth-signature" => signature
+        }
+      end
+    end
+  end
+end

data/lib/unleashed_client.rb

@@ -0,0 +1,35 @@
+require "unleashed_client/version"
+require_relative 'http/http_client'
+require 'httparty'
+
+module UnleashedClient
+  class SalesOrder
+    attr_reader :api_key, :api_id
+
+    def initialize(api_key:, api_id:, query: "")
+      @api_key = api_key
+      @api_id = api_id
+      @query = query
+      @unleashed_model = 'SalesOrders'
+    end
+    
+    def get_number_of_pages
+      response = HTTP::Client.get(api_id: @api_id, api_key: @api_key, query: @query, unleashed_model: @unleashed_model)
+      response["Pagination"]["NumberOfPages"]
+    end
+
+    def get_first_200
+      response = HTTP::Client.get(api_id: @api_id, api_key: @api_key, query: @query, unleashed_model: @unleashed_model)
+      response["Items"]
+    end
+
+    def get_orders_from_page(page_number:)
+      response = HTTP::Client.get_from_page(api_id: @api_id, api_key: @api_key, query: @query, unleashed_model: @unleashed_model, page_number: page_number)
+      response["Items"]
+    end
+
+    def get_details(guid:)
+      HTTP::Client.get_with_guid(api_id: @api_id, api_key: @api_key, query: @query, unleashed_model: @unleashed_model, guid: guid)
+    end
+  end
+end

data/lib/unleashed_client/version.rb

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

data/unleashed_client.gemspec

@@ -0,0 +1,32 @@
+require_relative 'lib/unleashed_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "unleashed_client"
+  spec.version       = UnleashedClient::VERSION
+  spec.authors       = ["thecookieorg"]
+  spec.email         = ["marko.manojlovic.bg@gmail.com"]
+
+  spec.summary       = %q{A Ruby wrapper for Unleashed API https://apidocs.unleashedsoftware.com}
+  spec.description   = %q{A Ruby wrapper for Unleashed API https://apidocs.unleashedsoftware.com}
+  spec.homepage      = "https://github.com/thecookieorg/unleashed_client"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/thecookieorg/unleashed_client"
+  spec.metadata["changelog_uri"] = "https://github.com/thecookieorg/unleashed_client/blob/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'httparty', '~> 0.18.0', '>= 0.18.1' 
+  
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "dotenv", '~> 2.7', '>= 2.7.6'
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: unleashed_client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- thecookieorg
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-09-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.6
+description: A Ruby wrapper for Unleashed API https://apidocs.unleashedsoftware.com
+email:
+- marko.manojlovic.bg@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec_status"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/http/auth.rb
+- lib/http/http_client.rb
+- lib/unleashed_client.rb
+- lib/unleashed_client/version.rb
+- unleashed_client.gemspec
+homepage: https://github.com/thecookieorg/unleashed_client
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/thecookieorg/unleashed_client
+  source_code_uri: https://github.com/thecookieorg/unleashed_client
+  changelog_uri: https://github.com/thecookieorg/unleashed_client/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A Ruby wrapper for Unleashed API https://apidocs.unleashedsoftware.com
+test_files: []