zoho_ruby 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e15ed161c6fefb6cc10087a5d1148c4a4fe3b9d5
-  data.tar.gz: dbc4e78cd0819cba91a21f5fdee3bab9c145a216
+  metadata.gz: d6d9eb280fbaf34cbf7ae8fce708a9bda910bb2b
+  data.tar.gz: aa3c96ae047f29633d3488a67d17b3838d09f017
 SHA512:
-  metadata.gz: 3ee020934f844a031747cb78f410b7ac907765e8c381a11616e1f278d6a17a301b1b966b6bd2fe8f066cfdce16bae326b77422e4b8b7ec52791b173b25b895cd
-  data.tar.gz: 301c47960bd63bbc4289945a4542e667082efdb82690decdaf175a6c36a3911c346adb79e76c384c165acd60b77a85773597106ea252200cb4831e5ff9852c36
+  metadata.gz: d616c5b9ea1b87b90b243c4b658ec1d7f9229742325b4453708cdcad8788184da60a2d9e00d3e345a4f7f92ab255a10eb7a79c5538ac5a29b1e435e59ff8ca39
+  data.tar.gz: 2374511457f3b55997ec53f48cf801376d7d47d39e1a549e182b2674b998802d5bed1fa2af56dcdaae4bf48fc6fed151794a9ef787930983bb43b3213512564c

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 200
 end
 ```
 ## Usage

data/docs/README.md

@@ -1 +1,4 @@
-TODO: Write usage instructions here
+# Table of contents
+
+* FINANCE
+  * [Inventory](inventory)

data/docs/inventory/README.md

@@ -0,0 +1,3 @@
+# Table of contents
+
+* [Items](items.md)

data/docs/inventory/items.md

@@ -0,0 +1,102 @@
+# Items
+
+An item is the product that is offered for sale. Nature of the product could be physical or digital. Based on the type of your business, you can offer one or more goods/services. Your product can be either fixed priced or a subscription service. Each of this may fall under a separate pricing category or have add ons associated to them. For more details check https://www.zoho.com/inventory/api/v1/#Items
+
+##### Create an item
+
+Creates a new item in Zoho Inventory.
+
+<!-- {.file-heading} -->
+
+```ruby
+params = { name: 'Bags-small', rate: 10, purchase_rate: 10 }
+
+Zoho::Inventory::Item.new.create(params)
+```
+Check https://www.zoho.com/inventory/api/v1/#Items_Create_an_item for more arguments that you can pass as params.
+
+##### Retrieve an item
+
+Fetches the details for an existing item.
+
+<!-- {.file-heading} -->
+
+```ruby
+item_id = '1234567890'
+
+Zoho::Inventory::Items.new.find(item_id)
+```
+
+##### Update an item
+
+Update the details of an item.
+
+<!-- {.file-heading} -->
+
+```ruby
+item_id = '1234567890'
+params = { name: 'Bags small', rate: 5 }
+
+Zoho::Inventory::Item.new.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.
+
+##### Delete an item
+
+Deletes an existing item from Zoho Inventory.
+
+<!-- {.file-heading} -->
+
+```ruby
+item_id = '1234567890'
+
+Zoho::Inventory::Item.new.destroy(item_id)
+```
+
+##### Mark as active
+
+Changes the status of an item to active.
+
+<!-- {.file-heading} -->
+
+```ruby
+item_id = '1234567890'
+
+Zoho::Inventory::Item.new.active!(item_id)
+```
+
+##### Mark as inactive
+
+Mark an item as inactive.
+
+<!-- {.file-heading} -->
+
+```ruby
+item_id = '1234567890'
+
+Zoho::Inventory::Item.new.inactive!(item_id)
+```
+
+##### List all the items
+
+Lists all the items present in Zoho Inventory.
+
+<!-- {.file-heading} -->
+
+```ruby
+Zoho::Inventory.new.all
+```
+
+##### List all the items based on arguments passed
+
+<!-- {.file-heading} -->
+
+```ruby
+Zoho::Inventory.new
+               .where(filter_by: 'Status.Active', sort_column: 'created_time'
+                      sort_order: 'D', search_text: 'Bags')
+
+# filter_by (`Status.All`, `Status.Active`, `Status.Inactive`)
+# sort_column (`name`, `rate`, `created_time`)
+# sort_order ('D', 'A')
+```

data/lib/zoho/inventory/item.rb

@@ -13,9 +13,9 @@ module Zoho
 
       def all
         uri = "#{BASE_URI}#{config_uri}&page=#{@page}" \
-          "&per_page=#{Zoho.configuration.per_page}" \
+          "&per_page=#{Zoho.configuration.per_page}"
 
-        request_item('get', uri)
+        return_items_with_image_link(uri)
       end
 
       def where(**args)
@@ -25,25 +25,31 @@ module Zoho
         uri << sort_uri(args[:sort_column], args[:sort_order])
         uri << search_uri(args[:search_text])
 
-        request_item('get', uri)
+        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]
 
-        request_item('post', uri, body: { JSONString: params.to_json })
+        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]
 
-        request_item('put', uri, body: { JSONString: params.to_json })
+        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]
 
-        request_item('get', uri)
+        result
       end
 
       def destroy(item_id)
@@ -87,6 +93,29 @@ module Zoho
         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
+      end
+
       def request_item(method, uri, params = {})
         response = HTTParty.send(method, uri, params)
         JSON.parse(response.body).with_indifferent_access

data/lib/zoho/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zoho_ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Patrick Ofilada
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-25 00:00:00.000000000 Z
+date: 2017-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -84,6 +84,8 @@ files:
 - bin/console
 - bin/setup
 - docs/README.md
+- docs/inventory/README.md
+- docs/inventory/items.md
 - lib/zoho.rb
 - lib/zoho/configuration.rb
 - lib/zoho/inventory/item.rb