zoho_ruby 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d6d9eb280fbaf34cbf7ae8fce708a9bda910bb2b
-  data.tar.gz: aa3c96ae047f29633d3488a67d17b3838d09f017
+  metadata.gz: 15566afc6b08355d0fe1aaacaa35dd0a922ccce3
+  data.tar.gz: acaba96cd216f58c89003f7491b84d1152ac6663
 SHA512:
-  metadata.gz: d616c5b9ea1b87b90b243c4b658ec1d7f9229742325b4453708cdcad8788184da60a2d9e00d3e345a4f7f92ab255a10eb7a79c5538ac5a29b1e435e59ff8ca39
-  data.tar.gz: 2374511457f3b55997ec53f48cf801376d7d47d39e1a549e182b2674b998802d5bed1fa2af56dcdaae4bf48fc6fed151794a9ef787930983bb43b3213512564c
+  metadata.gz: dc947e76b7d3551b2eca39d5d24b25f9ab8012f7d58579f8e1ca18b6c6d1fd3a6b56bf6f62e8faf394d4f9e838373f6c31e2738531898bdf231ad93c9de8f198
+  data.tar.gz: c33a931def604719024ec61a456dee0ad6784749c4fb671b1faf0aecb598b8d15dcd7eb53b1422aef69beb8607d6d485f91a72445d9ac14df775b9a3e29aa60b

data/README.md

@@ -27,7 +27,7 @@ If you have the `organization_id` and `auth_token` already, here's what you need
 Zoho.configure do |config|
   config.organization_id = 'your_organization_id'
   config.auth_token      = 'your_auth_token'
-  config.per_page        = 20 # Default and maximum items per page is 200
+  config.per_page        = 20 # Default and maximum items per page is 50
 end
 ```
 ## Usage

data/docs/inventory/README.md

@@ -1,3 +1,4 @@
 # Table of contents
 
+* [Item Groups](item_groups.md)
 * [Items](items.md)

data/docs/inventory/item_groups.md

@@ -0,0 +1,101 @@
+# Item Groups
+
+Item Group are the products that you sell or services that you render to various clients and can be purchased from various vendors in a business. Create and manage the item groups your business deals with and also create price lists for specific item and clients. For more details check https://www.zoho.com/inventory/api/v1/#Item_Groups
+
+##### Create an Item Group
+
+A new Item Group can a be created.
+
+<!-- {.file-heading} -->
+
+```ruby
+params = { group_name: 'Bags', unit: 'qty' }
+
+Zoho::Inventory::ItemGroup.create(params)
+```
+Check https://www.zoho.com/inventory/api/v1/#Item_Groups_Create_an_Item_Group for more arguments that you can pass as params.
+
+##### Retrieve an Item Group
+
+Fetches the details for an existing Item Group.
+
+<!-- {.file-heading} -->
+
+```ruby
+itemgroup_id = '1234567890'
+
+Zoho::Inventory::ItemGroup.find(itemgroup_id)
+```
+
+##### Update an Item Group
+
+Updates the details of an existing Item Group.
+
+<!-- {.file-heading} -->
+
+```ruby
+itemgroup_id = '1234567890'
+params = { group_name: 'Bags', unit: 'qty' }
+
+Zoho::Inventory::ItemGroup.update(itemgroup_id, params)
+```
+Check https://www.zoho.com/inventory/api/v1/#Item_Groups_Update_an_Item_Group for more arguments that you can pass as params.
+
+##### Delete an Item Group
+
+Deletes an existing Item Group from Zoho Inventory.
+
+<!-- {.file-heading} -->
+
+```ruby
+itemgroup_id = '1234567890'
+
+Zoho::Inventory::ItemGroup.destroy(itemgroup_id)
+```
+
+##### Mark as active
+
+Marks an Item group as Active.
+
+<!-- {.file-heading} -->
+
+```ruby
+itemgroup_id = '1234567890'
+
+Zoho::Inventory::ItemGroup.active!(itemgroup_id)
+```
+
+##### Mark as inactive
+
+Marks as Item Group as Inactive.
+
+<!-- {.file-heading} -->
+
+```ruby
+itemgroup_id = '1234567890'
+
+Zoho::Inventory::ItemGroup.inactive!(itemgroup_id)
+```
+
+##### List all Item Groups
+
+Lists all the Item Groups that are present in the Zoho Inventory organization.
+
+<!-- {.file-heading} -->
+
+```ruby
+Zoho::Inventory::ItemGroup.all
+```
+
+##### List all the items based on arguments passed
+
+<!-- {.file-heading} -->
+
+```ruby
+Zoho::Inventory::ItemGroup.all(filter_by: 'Status.Active', sort_column: 'created_time',
+                               sort_order: 'D', search_text: 'Bags', page: 1, per_page: 20)
+
+# filter_by (`Status.All`, `Status.Active`, `Status.Inactive`)
+# sort_column (`name`, `rate`, `created_time`)
+# sort_order ('D', 'A')
+```

data/docs/inventory/items.md

@@ -11,7 +11,7 @@ Creates a new item in Zoho Inventory.
 ```ruby
 params = { name: 'Bags-small', rate: 10, purchase_rate: 10 }
 
-Zoho::Inventory::Item.new.create(params)
+Zoho::Inventory::Item.create(params)
 ```
 Check https://www.zoho.com/inventory/api/v1/#Items_Create_an_item for more arguments that you can pass as params.
 
@@ -24,7 +24,7 @@ Fetches the details for an existing item.
 ```ruby
 item_id = '1234567890'
 
-Zoho::Inventory::Items.new.find(item_id)
+Zoho::Inventory::Item.find(item_id)
 ```
 
 ##### Update an item
@@ -37,7 +37,7 @@ Update the details of an item.
 item_id = '1234567890'
 params = { name: 'Bags small', rate: 5 }
 
-Zoho::Inventory::Item.new.update(item_id, params)
+Zoho::Inventory::Item.update(item_id, params)
 ```
 Check https://www.zoho.com/inventory/api/v1/#Items_Update_an_item for more arguments that you can pass as params.
 
@@ -50,7 +50,7 @@ Deletes an existing item from Zoho Inventory.
 ```ruby
 item_id = '1234567890'
 
-Zoho::Inventory::Item.new.destroy(item_id)
+Zoho::Inventory::Item.destroy(item_id)
 ```
 
 ##### Mark as active
@@ -62,7 +62,7 @@ Changes the status of an item to active.
 ```ruby
 item_id = '1234567890'
 
-Zoho::Inventory::Item.new.active!(item_id)
+Zoho::Inventory::Item.active!(item_id)
 ```
 
 ##### Mark as inactive
@@ -74,7 +74,7 @@ Mark an item as inactive.
 ```ruby
 item_id = '1234567890'
 
-Zoho::Inventory::Item.new.inactive!(item_id)
+Zoho::Inventory::Item.inactive!(item_id)
 ```
 
 ##### List all the items
@@ -84,7 +84,7 @@ Lists all the items present in Zoho Inventory.
 <!-- {.file-heading} -->
 
 ```ruby
-Zoho::Inventory.new.all
+Zoho::Inventory::Item.all
 ```
 
 ##### List all the items based on arguments passed
@@ -92,9 +92,8 @@ Zoho::Inventory.new.all
 <!-- {.file-heading} -->
 
 ```ruby
-Zoho::Inventory.new
-               .where(filter_by: 'Status.Active', sort_column: 'created_time'
-                      sort_order: 'D', search_text: 'Bags')
+Zoho::Inventory::Item.all(filter_by: 'Status.Active', sort_column: 'created_time',
+                    sort_order: 'D', search_text: 'Bags', page: 1, per_page: 20)
 
 # filter_by (`Status.All`, `Status.Active`, `Status.Inactive`)
 # sort_column (`name`, `rate`, `created_time`)

data/lib/zoho/configuration.rb

@@ -3,7 +3,7 @@ module Zoho
     attr_accessor :organization_id, :auth_token, :per_page
 
     def initialize
-      @per_page = 200
+      @per_page = 50
     end
   end
 end

data/lib/zoho/inventory/api.rb

@@ -0,0 +1,40 @@
+require 'httparty'
+require 'json'
+
+module Zoho
+  module Inventory
+    class API
+      BASE_URI = 'https://inventory.zoho.com/api/v1/'.freeze
+
+      attr_reader :type
+
+      def initialize(type:)
+        @type = type
+      end
+
+      def construct_uri(path = '')
+        URI.parse("#{BASE_URI}#{type}#{path}#{config_uri}")
+      end
+
+      def request(uri, method, params = {})
+        response = HTTParty.send(method, uri, params)
+        JSON.parse(response.body)
+      end
+
+      def merge_options(options = {})
+        options.map { |key, value| "#{key}=#{value}" }.join('&')
+      end
+
+      def default_options
+        { page: 1, per_page: Zoho.configuration.per_page }
+      end
+
+      private
+
+      def config_uri
+        "?authtoken=#{Zoho.configuration.auth_token}" \
+        "&organization_id=#{Zoho.configuration.organization_id}"
+      end
+    end
+  end
+end

data/lib/zoho/inventory/item.rb

@@ -1,124 +1,42 @@
-require 'active_support/core_ext/hash/indifferent_access'
-require 'httparty'
-require 'json'
-
 module Zoho
   module Inventory
     class Item
-      BASE_URI = 'https://inventory.zoho.com/api/v1/items'.freeze
-
-      def initialize(page: 1)
-        @page = page
-      end
-
-      def all
-        uri = "#{BASE_URI}#{config_uri}&page=#{@page}" \
-          "&per_page=#{Zoho.configuration.per_page}"
-
-        return_items_with_image_link(uri)
-      end
-
-      def where(**args)
-        uri = "#{BASE_URI}#{config_uri}&page=#{@page}" \
-          "&per_page=#{Zoho.configuration.per_page}"
-        uri << filter_uri(args[:filter_by])
-        uri << sort_uri(args[:sort_column], args[:sort_order])
-        uri << search_uri(args[:search_text])
-
-        return_items_with_image_link(uri)
-      end
-
-      def create(params)
-        uri = "#{BASE_URI}#{config_uri}"
-        result = request_item('post', uri, body: { JSONString: params.to_json })
-        add_image_link(result[:item]) if result[:item]
-
-        result
-      end
-
-      def update(item_id, params)
-        uri = "#{BASE_URI}/#{item_id}#{config_uri}"
-        result = request_item('put', uri, body: { JSONString: params.to_json })
-        add_image_link(result[:item]) if result[:item]
-
-        result
-      end
-
-      def find(item_id)
-        uri = "#{BASE_URI}/#{item_id}#{config_uri}"
-        result = request_item('get', uri)
-        add_image_link(result[:item]) if result[:item]
-
-        result
-      end
-
-      def destroy(item_id)
-        uri = "#{BASE_URI}/#{item_id}#{config_uri}"
+      @api = Zoho::Inventory::API.new(type: 'items')
 
-        request_item('delete', uri)
+      def self.all(options = @api.default_options)
+        uri       = @api.construct_uri
+        uri.query = [uri.query, @api.merge_options(options)].join('&')
+        @api.request(uri, 'get')
       end
 
-      def active!(item_id)
-        uri = "#{BASE_URI}/#{item_id}/active#{config_uri}"
-
-        request_item('post', uri)
+      def self.find(item_id)
+        uri = @api.construct_uri("/#{item_id}")
+        @api.request(uri, 'get')
       end
 
-      def inactive!(item_id)
-        uri = "#{BASE_URI}/#{item_id}/inactive#{config_uri}"
-
-        request_item('post', uri)
+      def self.create(params)
+        uri = @api.construct_uri
+        @api.request(uri, 'post', body: { JSONString: params.to_json })
       end
 
-      private
-
-      def config_uri
-        "?authtoken=#{Zoho.configuration.auth_token}" \
-        "&organization_id=#{Zoho.configuration.organization_id}"
+      def self.update(item_id, params)
+        uri = @api.construct_uri("/#{item_id}")
+        @api.request(uri, 'put', body: { JSONString: params.to_json })
       end
 
-      def filter_uri(filter_by)
-        filter_by.nil? ? '' : "&filter_by=#{filter_by}"
+      def self.destroy(item_id)
+        uri = @api.construct_uri("/#{item_id}")
+        @api.request(uri, 'delete')
       end
 
-      def sort_uri(sort_column, sort_order = 'D')
-        uri = ''
-        uri << "&sort_column=#{sort_column}"
-        uri << "&sort_order=#{sort_order}"
-
-        sort_column.nil? ? '' : uri
-      end
-
-      def search_uri(text)
-        text.nil? ? '' : "&search_text=#{text}"
-      end
-
-      def image_uri(item_id)
-        "#{BASE_URI}/#{item_id}/image#{config_uri}"
-      end
-
-      def add_image_link(item)
-        item[:image_link] = unless item[:image_name].empty?
-                              image_uri(item[:item_id])
-                            end
-      end
-
-      def items_add_image_link(items)
-        items.map do |item|
-          add_image_link(item) if item
-        end
-      end
-
-      def return_items_with_image_link(uri)
-        result = request_item('get', uri)
-        items_add_image_link(result[:items]) if result[:items]
-
-        result
+      def self.active!(item_id)
+        uri = @api.construct_uri("/#{item_id}/active")
+        @api.request(uri, 'post')
       end
 
-      def request_item(method, uri, params = {})
-        response = HTTParty.send(method, uri, params)
-        JSON.parse(response.body).with_indifferent_access
+      def self.inactive!(item_id)
+        uri = @api.construct_uri("/#{item_id}/inactive")
+        @api.request(uri, 'post')
       end
     end
   end

data/lib/zoho/inventory/item_group.rb

@@ -0,0 +1,43 @@
+module Zoho
+  module Inventory
+    class ItemGroup
+      @api = Zoho::Inventory::API.new(type: 'itemgroups')
+
+      def self.all(options = @api.default_options)
+        uri       = @api.construct_uri
+        uri.query = [uri.query, @api.merge_options(options)].join('&')
+        @api.request(uri, 'get')
+      end
+
+      def self.find(itemgroup_id)
+        uri = @api.construct_uri("/#{itemgroup_id}")
+        @api.request(uri, 'get')
+      end
+
+      def self.create(params)
+        uri = @api.construct_uri
+        @api.request(uri, 'post', body: { JSONString: params.to_json })
+      end
+
+      def self.update(itemgroup_id, params)
+        uri = @api.construct_uri("/#{itemgroup_id}")
+        @api.request(uri, 'put', body: { JSONString: params.to_json })
+      end
+
+      def self.destroy(itemgroup_id)
+        uri = @api.construct_uri("/#{itemgroup_id}")
+        @api.request(uri, 'delete')
+      end
+
+      def self.active!(itemgroup_id)
+        uri = @api.construct_uri("/#{itemgroup_id}/active")
+        @api.request(uri, 'post')
+      end
+
+      def self.inactive!(itemgroup_id)
+        uri = @api.construct_uri("/#{itemgroup_id}/inactive")
+        @api.request(uri, 'post')
+      end
+    end
+  end
+end

data/lib/zoho/version.rb

@@ -1,3 +1,3 @@
 module Zoho
-  VERSION = '0.0.2'.freeze
+  VERSION = '0.0.3'.freeze
 end

data/lib/zoho.rb

@@ -1,5 +1,7 @@
 require 'zoho/version'
 require 'zoho/configuration'
+require 'zoho/inventory/api'
+require 'zoho/inventory/item_group'
 require 'zoho/inventory/item'
 
 module Zoho

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zoho_ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Patrick Ofilada
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-29 00:00:00.000000000 Z
+date: 2018-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -85,10 +85,13 @@ files:
 - bin/setup
 - docs/README.md
 - docs/inventory/README.md
+- docs/inventory/item_groups.md
 - docs/inventory/items.md
 - lib/zoho.rb
 - lib/zoho/configuration.rb
+- lib/zoho/inventory/api.rb
 - lib/zoho/inventory/item.rb
+- lib/zoho/inventory/item_group.rb
 - lib/zoho/version.rb
 - lib/zoho_ruby.rb
 - zoho.gemspec
@@ -112,7 +115,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Ruby wrapper for Zoho API.