voxbone-ruby 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fe08e01083e7a6fe667dc820b5d8f35059d74ce5
-  data.tar.gz: f8f4e1d57a3610ccd10207f2b5d03b5e43bb5574
+  metadata.gz: 14a29040198f11bc7b96bb55c38ed1f6f6d9b818
+  data.tar.gz: 5869c09e96d639b9d54419d2888b83f7d55f8cc2
 SHA512:
-  metadata.gz: 7cce10925e258517cc299633a41436ddf6b57feee641ecc40c00682fd213a8af1526ce9df12c4fce7af4b46585d44508ec9eee7d2a505753e6c130657e9a68a9
-  data.tar.gz: fda26751c9ea902abccbbd6f2d2c0765a7e2a583cb35afc6b70f8533ec64b12042140349297b4898b85e13ab0422de279769bde72d26c14f8c9535a60de09459
+  metadata.gz: 769e012705cc260fa8fdcfc75c97ed501ed09d4a70e01027726bf4bf1c40d73ea169721ddc5386a022c3b537df79021cb68916bdc3e9c322f2fdde33dae0270b
+  data.tar.gz: cedb10e70649e2850c5023d17f3f29563ee53f6274a16cf4a29847a87eaf89b85dbc7fb7a11529065e745c62b89e7d5a466490fcd58161424716e0d6c5e8c15e

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    voxbone-ruby (0.0.1)
+    voxbone-ruby (0.0.2)
       httparty
 
 GEM

data/lib/voxbone.rb

@@ -3,3 +3,4 @@ require 'voxbone/version'
 require 'voxbone/config'
 
 require 'voxbone/inventory'
+require 'voxbone/ordering'

data/lib/voxbone/inventory.rb

@@ -51,7 +51,7 @@ module Voxbone
     #                                that you can specify multiple features by
     #                                repeating the query parameter.
     def list_did_group(**options)
-      get('/inventory/didgroup', options)
+      send_get('/inventory/didgroup', options)
     end
   end
 

data/lib/voxbone/ordering.rb

@@ -0,0 +1,78 @@
+module Voxbone
+  module Ordering
+    # Create Cart
+    #
+    # `create_cart` is a method that allows you to create a cart. Note: The
+    # creation of a cart depends on your own business logic, but you'll always
+    # need to create at least one cart to place an order (`checkout_cart`). You
+    # can place multiple orders per cart or you can create separate carts for
+    # each order. Note that different product types (DID, Capacity or prepaid
+    # credits) can be added into a single cart.
+    #
+    # options - Type: Hash. Parameters used to create the cart.
+    #           customer_reference - A parameter that can be used for your own
+    #                                reference.
+    #           description        - The description or name you want to give
+    #                                the cart.
+    def create_cart(**options)
+      send_put '/ordering/cart', **options
+    end
+
+    # Add to Cart
+    #
+    # `add_to_cart` allows you to add items (order_products) to a specific cart
+    # before checking out the cart. Different product types (DID, CAPACITY or
+    # CREDIT_PACKAGE) can be added into one single cart.
+    #
+    # Parameters:
+    #
+    # options - Type: Hash. Parameters used to add an item to a cart.
+    #   - :cart_identifier - Type: String. Identifies the cart and is returned
+    #     by the createCart method or can be retrieved with the list_cart
+    #     method. (Required)
+    #   - :did_cart_item - Type: Hash. Corresponds to DIDs (VoxDID or Vox800).
+    #     Note that you can specify multiple DID groups by repeating the query
+    #     parameter.
+    #     - :did_group_ids - Type: Integer (multiple). To add one or multiple
+    #       DIDs to your cart, you need to specify a valid ID for the DID group
+    #       of the DIDs.
+    #     - :quantity - Type: Integer. Amount of DIDs from that DID group.
+    #   - :capacity_cart_item - Type: Hash. Corresponds to capacity (VoxTRUNK
+    #     channels).
+    #     - :zone - To add channels to your cart, you need to specify a valid
+    #       zone (A, B, C or WORLDWIDE). Only one capacity_cart_item can be
+    #       added per request and capacity must be ordered in multiple of 10.
+    #     - :quantity - Amount of channels required.
+    #   - :credit_package_cart_item - Type: Hash. Corresponds to prepaid
+    #     credits.
+    #     - :credit_package_id - Type: String. To add prepaid credits to your
+    #       cart, you need to specify a valid ID for the credit_package
+    #     - :quantity - Type: Integer. The amount of prepaid credits required.
+    def add_to_cart(**options)
+      cart_id = options.delete(:cart_id)
+      send_post "/ordering/cart/#{cart_id}/product", **options
+    end
+
+    # Checkout Cart
+    #
+    # `checkout_cart` allows you to checkout a cart and place an order for all
+    # the products contained in the cart. You can then retrieve your orders
+    # using the list_order method.
+    #
+    # Parameters:
+    # options - Type: Hash. Parameters used to checkout a cart.
+    #   - :cart_identifier - The identifier of your cart which is formed of a
+    #     fixed string such as “apiv3:60677:” and an ID which is incremented
+    #     each time a new cart is created.
+    def checkout_cart(**options)
+      # For some reason the API docs indicate that "cartIdentifier" should be
+      # given as a dynamic segment AND a query string.
+      cart_id = options.delete(:cart_id)
+      send_get(
+        "/ordering/cart/#{cart_id}/checkout",
+        **options, cart_identifier: cart_id)
+    end
+  end
+
+  extend Ordering
+end

data/lib/voxbone/version.rb

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

data/lib/voxbone/voxbone.rb

@@ -10,15 +10,29 @@ module Voxbone
   }.freeze
 
   class << self
-    def get(path, **options)
+    def send_get(path, **options)
+      query = camelize_keys(options) if options
+      get(
+        path, query: query, headers: HEADERS, basic_auth: auth)
+    end
+
+    def send_put(path, **options)
       auth = { username: username, password: password }
       query = camelize_keys(options) if options
-      super(
+      put(
+        path, query: query, headers: HEADERS, basic_auth: auth)
+    end
+
+    def send_post(path, **options)
+      auth = { username: username, password: password }
+      query = camelize_keys(options)
+      post(
         path, query: query, headers: HEADERS, basic_auth: auth)
     end
 
-    def camelize_keys(hash)
-      Hash[hash.map { |key, value| [camelize(key), value] }]
+    def camelize_keys(obj)
+      return obj unless obj.is_a?(Hash)
+      Hash[obj.map { |key, value| [camelize(key), camelize_keys(value)] }]
     end
 
     def camelize(string)
@@ -26,5 +40,9 @@ module Voxbone
       transformed_parts = parts[1..-1].map(&:capitalize).unshift(parts[0])
       transformed_parts.join
     end
+
+    def auth
+      { username: username, password: password }
+    end
   end
 end

data/spec/voxbone/inventory_spec.rb

@@ -5,8 +5,15 @@ describe Voxbone::Inventory do
     it 'correctly makes the request' do
       expect(Voxbone).to receive(:get).with(
         '/inventory/didgroup',
-        country_code_a3: 'USA', page_number: 0, page_size: 5, area_code: '225')
-
+        query: {
+          'countryCodeA3' => 'USA',
+          'pageNumber' => 0,
+          'pageSize' => 5,
+          'areaCode' => '225'
+        },
+        headers: Voxbone::HEADERS,
+        basic_auth: Voxbone.auth
+      )
       Voxbone.list_did_group(
         country_code_a3: 'USA', page_number: 0, page_size: 5, area_code: '225')
     end

data/spec/voxbone/ordering_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe Voxbone::Ordering do
+  describe '#create_cart' do
+    it 'correctly makes the request' do
+      expect(Voxbone).to receive(:put).with(
+        '/ordering/cart',
+        query: { 'customerReference' => 'me', 'description' => 'my_cart' },
+        headers: Voxbone::HEADERS,
+        basic_auth: Voxbone.auth
+      )
+      Voxbone.create_cart(
+        customer_reference: 'me', description: 'my_cart'
+      )
+    end
+  end
+
+  describe '#add_to_cart' do
+    it 'correctly makes the request' do
+      expect(Voxbone).to receive(:post).with(
+        '/ordering/cart/1234/product',
+        query: {
+          'didCartItem' => {
+            'didGroupIds' => 1,
+            'quantity' => 1
+          }
+        },
+        headers: Voxbone::HEADERS,
+        basic_auth: Voxbone.auth
+      )
+      Voxbone.add_to_cart(
+        cart_id: '1234',
+        did_cart_item: {
+          did_group_ids: 1,
+          quantity: 1
+        }
+      )
+    end
+  end
+
+  describe '#checkout_cart' do
+    it 'correctly makes the request' do
+      expect(Voxbone).to receive(:get).with(
+        '/ordering/cart/1234/checkout',
+        query: { 'cartIdentifier' => '1234' },
+        headers: Voxbone::HEADERS,
+        basic_auth: Voxbone.auth
+      )
+      Voxbone.checkout_cart(cart_id: '1234')
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: voxbone-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Julien Negrotto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-17 00:00:00.000000000 Z
+date: 2016-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -66,10 +66,12 @@ files:
 - lib/voxbone.rb
 - lib/voxbone/config.rb
 - lib/voxbone/inventory.rb
+- lib/voxbone/ordering.rb
 - lib/voxbone/version.rb
 - lib/voxbone/voxbone.rb
 - spec/spec_helper.rb
 - spec/voxbone/inventory_spec.rb
+- spec/voxbone/ordering_spec.rb
 - voxbone-ruby.gemspec
 homepage: ''
 licenses: []
@@ -97,4 +99,5 @@ summary: A gem for interacting with Voxbone's REST API.
 test_files:
 - spec/spec_helper.rb
 - spec/voxbone/inventory_spec.rb
+- spec/voxbone/ordering_spec.rb
 has_rdoc: