zoho_inventory 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 759cfb78a7c29a45dff7e841138f74ee48304b06
+  data.tar.gz: fe114c21d4abec900a377bf4d975918a295b939b
+SHA512:
+  metadata.gz: 9cb3774f6fd8abc9a82b9bc04c582fd302cc328feeacca8d6d49a0a7cb3c14b4eae547814e02d3b7d975fb1bdc9cd6f4215858461e5ae899b5e7d9d35660ca3d
+  data.tar.gz: ccfbade7551a22a8ad946f56dfdf0fe51cb05fdf5e2640ebdd515d270cd1e9610de6aaf4ecca4f5e5eca8e2c70ffee46a3f4aa876ced95b557953a467de581d0

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.16.5

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 vincent.rolea@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 [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in zoho_inventory.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,51 @@
+PATH
+  remote: .
+  specs:
+    zoho_inventory (0.1.0)
+      faraday (~> 0.15)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    faraday (0.15.3)
+      multipart-post (>= 1.2, < 3)
+    hashdiff (0.3.7)
+    multipart-post (2.0.0)
+    public_suffix (3.0.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    safe_yaml (1.0.4)
+    webmock (3.4.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  webmock (~> 3.4)
+  zoho_inventory!
+
+BUNDLED WITH
+   1.16.5

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Vincent Rolea
+
+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,95 @@
+⚠️ This is a work in progress, only CRUD operations are available for Zoho models for now, and models will be added gradually.
+
+# ZohoInventory
+
+This gem is a wrapper for the Zoho Inventory API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'zoho_inventory'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install zoho_inventory
+
+## Usage
+
+### Authentication
+
+In order to authenticate to the Zoho Inventory API, do the following:
+
+```ruby
+ZohoInventory.auth_token = "REPLACE_WITH_YOUR_AUTH_TOKEN"
+ZohoInventory.organization_id = "REPLACE_WITH_YOUR_ORGANIZATION_ID"
+```
+
+### Errors
+
+Every API call that result in an error from zoho will result in a `ZohoError` exception thrown.
+
+```ruby
+begin
+  # Zoho API Call
+  ZohoInventory::Item.retrieve("item_id")
+rescue ZohoError => e
+  # Exception thrown
+  puts e.message
+end
+```
+
+### CRUD Operaions
+
+The gem implements all CRUD operations available to the different Zoho models. [More info on available operations here](https://www.zoho.com/inventory/api/v1/)
+
+For example, with items:
+
+```ruby
+# Create an item
+ZohoInventory::Item.create({ name: "Death Star", ... })
+
+# List all items
+ZohoInventory::Item.list
+
+# Retrieve an item
+ZohoInventory::Item.retrieve(item_id)
+
+# Update an item
+ZohoInventory.update(item_id, { name: "X-Wing", ... })
+
+# Delete an item
+ZohoInventory.delete(item_id)
+```
+
+The Zoho models avaiable in the gem are: `organizations`, `items`, `users` and `contacts`.
+
+Special model-specific actions such as `mark_as_active` will be added once all model CRUD actions are implemented. It will be documented below
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Virolea/zoho_inventory. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ZohoInventory project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/zoho_inventory/blob/master/CODE_OF_CONDUCT.md).
+
+
+## Contact
+
+Ping me on [Twitter](https://twitter.com/V_Rolea) for any question!

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "zoho_inventory"
+
+# 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/zoho_inventory.rb

@@ -0,0 +1,39 @@
+## Version
+require "zoho_inventory/version"
+
+## Dependencies
+require 'faraday'
+require 'json'
+
+## API client
+require "zoho_inventory/client"
+require "zoho_inventory/request"
+
+## API resources
+# Abstract class
+require "zoho_inventory/zoho_object"
+
+# Models
+require "zoho_inventory/contact"
+require "zoho_inventory/item"
+require "zoho_inventory/organization"
+require "zoho_inventory/user"
+
+
+## Support
+require 'zoho_inventory/util'
+
+module ZohoInventory
+  @api_base = "https://inventory.zoho.com/api"
+
+  class << self
+    attr_accessor :organization_id, :auth_token, :api_base
+
+    def credentials
+      [ZohoInventory.organization_id, ZohoInventory.auth_token]
+    end
+  end
+
+  # Errors
+  class ZohoError < StandardError; end
+end

data/lib/zoho_inventory/client.rb

@@ -0,0 +1,18 @@
+module ZohoInventory
+  class Client
+    def self.default_client
+      @conn ||= set_conn
+    end
+
+    class << self
+      private
+
+      def set_conn
+        Faraday.new do |faraday|
+          faraday.request :url_encoded
+          faraday.adapter Faraday.default_adapter
+        end
+      end
+    end
+  end
+end

data/lib/zoho_inventory/contact.rb

@@ -0,0 +1,7 @@
+module ZohoInventory
+  class Contact < ZohoObject
+    accept_api_methods [:list, :create, :retrieve, :update, :delete]
+
+    OBJECT_NAME = "contact".freeze
+  end
+end

data/lib/zoho_inventory/item.rb

@@ -0,0 +1,7 @@
+module ZohoInventory
+  class Item < ZohoObject
+    accept_api_methods [:list, :create, :retrieve, :update, :delete]
+
+    OBJECT_NAME = "item".freeze
+  end
+end

data/lib/zoho_inventory/organization.rb

@@ -0,0 +1,7 @@
+module ZohoInventory
+  class Organization < ZohoObject
+    accept_api_methods [:list, :create, :retrieve, :update]
+
+    OBJECT_NAME = "organization".freeze
+  end
+end

data/lib/zoho_inventory/request.rb

@@ -0,0 +1,32 @@
+module ZohoInventory
+  module Request
+    def request(method, path, object_name = nil, params = {})
+      client = Client.default_client
+      query_params = nil
+      headers = {}
+      url = build_url_from_path(path)
+      body = { JSONString: params.to_json }
+      r = client.run_request(method, url, body, headers) do |req|
+        req.params = query_params if query_params
+      end
+      response = JSON.parse(r.body)
+      handle_response(response, object_name)
+    end
+
+    private
+
+    def handle_response(response, object_name)
+      if response["code"] == 0
+        if object_name
+          object = Util.object_classes[object_name]
+          results = [response[object_name], response["#{object_name}s"]].compact[0]
+        else
+          response["message"]
+        end
+      else
+        message = response["message"]
+        raise ZohoError, message
+      end
+    end
+  end
+end

data/lib/zoho_inventory/user.rb

@@ -0,0 +1,7 @@
+module ZohoInventory
+  class User < ZohoObject
+    accept_api_methods [:list, :create, :retrieve, :update, :delete]
+
+    OBJECT_NAME = "user".freeze
+  end
+end

data/lib/zoho_inventory/util.rb

@@ -0,0 +1,21 @@
+module ZohoInventory
+  module Util
+    def self.object_classes
+      @object_classes ||= {
+        Item::OBJECT_NAME => Item,
+        Contact::OBJECT_NAME => Contact,
+        Organization::OBJECT_NAME => Organization,
+        User::OBJECT_NAME => User
+      }
+    end
+
+    def self.remote_object_key
+      @remote_object_keys ||= {
+        Item::OBJECT_NAME => 'item',
+        Contact::OBJECT_NAME => 'contact',
+        Organization::OBJECT_NAME => 'organization',
+        User::OBJECT_NAME => 'user'
+      }
+    end
+  end
+end

data/lib/zoho_inventory/version.rb

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

data/lib/zoho_inventory/zoho_object.rb

@@ -0,0 +1,86 @@
+module ZohoInventory
+  class ZohoObject
+    # Zoho Object abstract class
+    # It implements methods common to all resources available from Zoho
+
+    extend Request
+    attr_reader :values
+
+    @list = false
+    @create = false
+    @retrieve = false
+    @update = false
+    @delete = false
+
+    def self.accept_api_methods(methods)
+      @list = methods.include? :list
+      @create = methods.include? :create
+      @retrieve = methods.include? :retrieve
+      @update = methods.include? :update
+      @delete = methods.include? :delete
+    end
+
+    def self.api_methods
+      {
+        list: @list,
+        create: @create ,
+        retrieve: @retrieve,
+        update: @update,
+        delete: @delete
+      }
+    end
+
+    class << self
+      private
+
+      def client
+        ZohoInventory::Client.new
+      end
+
+      def check_authorized_methods(method)
+        raise "You cannot call #{method.to_s} on this resource" unless api_methods[method]
+      end
+    end
+
+    def self.build_url_from_path(path, query_params = {})
+      api_base = ZohoInventory.api_base
+      organization_id, auth_token = ZohoInventory.credentials
+      query_params.merge!({ authtoken: auth_token, organization_id: organization_id })
+      encoded_params = URI.encode_www_form(query_params)
+      "#{api_base}#{path}?#{encoded_params}"
+    end
+
+    def self.resource_url
+      "/v1/#{self::OBJECT_NAME}s"
+    end
+
+    def self.object_key
+      Util.remote_object_key[self::OBJECT_NAME]
+    end
+
+    def self.list
+      check_authorized_methods(:list)
+      request(:get, resource_url, self::OBJECT_NAME)
+    end
+
+    def self.create(params = {})
+      check_authorized_methods(:create)
+      request(:post, resource_url, object_key, params)
+    end
+
+    def self.retrieve(id)
+      check_authorized_methods(:retrieve)
+      request(:get, "#{resource_url}/#{id}", self::OBJECT_NAME)
+    end
+
+    def self.update(id, params = {})
+      check_authorized_methods(:update)
+      request(:put, "#{resource_url}/#{id}", object_key, params)
+    end
+
+    def self.delete(id)
+      check_authorized_methods(:delete)
+      request(:delete, "#{resource_url}/#{id}")
+    end
+  end
+end

data/test.rb

@@ -0,0 +1,15 @@
+class SupClass
+  def metaclass
+    class << self; self; end
+  end
+end
+
+class TestClass < SupClass
+  def self.resource_url
+    name
+  end
+end
+
+p SupClass.new.metaclass
+p TestClass.new.metaclass
+p TestClass.resource_url

data/zoho_inventory.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "zoho_inventory/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "zoho_inventory"
+  spec.version       = ZohoInventory::VERSION
+  spec.authors       = ["Vincent Rolea"]
+  spec.email         = ["vincent.rolea@gmail.com"]
+
+  spec.summary       = "Ruby wrapper for the Zoho Inventory API"
+  spec.license       = "MIT"
+
+  # 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_dependency "faraday", "~>0.15"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 3.4"
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: zoho_inventory
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Vincent Rolea
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-01-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+description: 
+email:
+- vincent.rolea@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/zoho_inventory.rb
+- lib/zoho_inventory/client.rb
+- lib/zoho_inventory/contact.rb
+- lib/zoho_inventory/item.rb
+- lib/zoho_inventory/organization.rb
+- lib/zoho_inventory/request.rb
+- lib/zoho_inventory/user.rb
+- lib/zoho_inventory/util.rb
+- lib/zoho_inventory/version.rb
+- lib/zoho_inventory/zoho_object.rb
+- test.rb
+- zoho_inventory.gemspec
+homepage: 
+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.6.13
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for the Zoho Inventory API
+test_files: []