gonebusy-ruby-client 0.0.9 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bb2f3bc9e6c616526afbc1c62a58aaf6316e59fd
-  data.tar.gz: 47bf5dcb379793dc565542c87d476f23618b36e1
+  metadata.gz: 78b8512a26ebf173b7d5dff019ada61c11f3e537
+  data.tar.gz: ae3379eb6e60d839b67cf3c9e7e84a2797f9b086
 SHA512:
-  metadata.gz: cf29cda26c000d730e1a36b061db07e26738b289d9fdf67699cd468a8b7de8174ecc72186c3578198e50b9ca473faa06ef22c8661fe129ad837ea70d92207b8c
-  data.tar.gz: f3b441c1df95d8779078ee0f3306a3e38a0a4f15ff3f8164538f37be9603b4356a012996f7cd64e56d22b86cb228e2a366bb432a561afe46103be14caebab599
+  metadata.gz: b95d3c6c28de64dd0ebe9b514abf93a5f205ab93421b99c507ec5bd2b8e03b57064a4891085f1d6b3cf5a88ed79f7af0792055b21ff33fc573eb9a5fbf532dcf
+  data.tar.gz: 2d18a850c595ac5593a207ffc100d7bc23beb2f39ac39678a654ddbf833b12e2bb39d842ca36f5a087fefd194376156d56d1abcaeb7a26960ce8060733602669

data/README.md

@@ -18,63 +18,18 @@ This client library is a Ruby gem which can be compiled and used in your Ruby an
 2. Run ``` gem build gonebusy.gemspec ``` to build the gem.
 3. Once built, the gem can be installed on the current work environment using ``` gem install gonebusy-0.0.9.gem ```
 
-![Building Gem](http://apidocs.io/illustration/ruby?step=buildSDK&workspaceFolder=Gonebusy-Ruby&workspaceName=Gonebusy-Ruby&projectName=gonebusy&gemName=gonebusy&gemVer=0.0.9)
-
 ## How to Use
 
-The following section explains how to use the Gonebusy Ruby Gem in a new Rails project using RubyMine™. The basic workflow presented here is also applicable if you prefer using a different editor or IDE.
-
-### 1. Starting a new project
-
-Close any existing projects in RubyMine™ by selecting ``` File -> Close Project ```. Next, click on ``` Create New Project ``` to create a new project from scratch.
-
-![Create a new project in RubyMine](http://apidocs.io/illustration/ruby?step=createNewProject0&workspaceFolder=Gonebusy-Ruby&workspaceName=Gonebusy&projectName=gonebusy&gemName=gonebusy&gemVer=0.0.9)
-
-Next, provide ``` TestApp ``` as the project name, choose ``` Rails Application ``` as the project type, and click ``` OK ```.
-
-![Create a new Rails Application in RubyMine - step 1](http://apidocs.io/illustration/ruby?step=createNewProject1&workspaceFolder=Gonebusy-Ruby&workspaceName=Gonebusy&projectName=gonebusy&gemName=gonebusy&gemVer=0.0.9)
-
-In the next dialog make sure that correct *Ruby SDK* is being used (minimum 2.0.0) and click ``` OK ```.
-
-![Create a new Rails Application in RubyMine - step 2](http://apidocs.io/illustration/ruby?step=createNewProject2&workspaceFolder=Gonebusy-Ruby&workspaceName=Gonebusy&projectName=gonebusy&gemName=gonebusy&gemVer=0.0.9)
-
-This will create a new Rails Application project with an existing set of files and folder.
-
-### 2. Add reference of the gem
-
-In order to use the Gonebusy gem in the new project we must add a gem reference. Locate the ```Gemfile``` in the *Project Explorer* window under the ``` TestApp ``` project node. The file contains references to all gems being used in the project. Here, add the reference to the library gem by adding the following line: ``` gem 'gonebusy', '~> 0.0.9' ```
-
-![Add references of the Gemfile](http://apidocs.io/illustration/ruby?step=addReference&workspaceFolder=Gonebusy-Ruby&workspaceName=Gonebusy&projectName=gonebusy&gemName=gonebusy&gemVer=0.0.9)
+### API Key
 
-### 3. Adding a new Rails Controller
+If testing with Sandbox, [Signup/Logon](https://sandbox.gonebusy.com/login) at https://sandbox.gonebusy.com/login.
 
-Once the ``` TestApp ``` project is created, a folder named ``` controllers ``` will be visible in the *Project Explorer* under the following path: ``` TestApp > app > controllers ```. Right click on this folder and select ``` New -> Run Rails Generator... ```.
-
-![Run Rails Generator on Controllers Folder](http://apidocs.io/illustration/ruby?step=addCode0&workspaceFolder=Gonebusy-Ruby&workspaceName=Gonebusy&projectName=gonebusy&gemName=gonebusy&gemVer=0.0.9)
-
-Selecting the said option will popup a small window where the generator names are displayed. Here, select the ``` controller ``` template.
-
-![Create a new Controller](http://apidocs.io/illustration/ruby?step=addCode1&workspaceFolder=Gonebusy-Ruby&workspaceName=Gonebusy&projectName=gonebusy&gemName=gonebusy&gemVer=0.0.9)
-
-Next, a popup window will ask you for a Controller name and included Actions. For controller name provide ``` Hello ``` and include an action named ``` Index ``` and click ``` OK ```.
-
-![Add a new Controller](http://apidocs.io/illustration/ruby?step=addCode2&workspaceFolder=Gonebusy-Ruby&workspaceName=Gonebusy&projectName=gonebusy&gemName=gonebusy&gemVer=0.0.9)
-
-A new controller class anmed ``` HelloController ``` will be created in a file named ``` hello_controller.rb ``` containing a method named ``` Index ```. In this method, add code for initialization and a sample for its usage.
-
-![Initialize the library](http://apidocs.io/illustration/ruby?step=addCode3&workspaceFolder=Gonebusy-Ruby&workspaceName=Gonebusy&projectName=gonebusy&gemName=gonebusy&gemVer=0.0.9)
-
-## How to Test
-
-You can test the generated SDK and the server with automatically generated test
-cases as follows:
+If using Production site, [Signup/Logon](https://beta.gonebusy.com/login) at https://beta.gonebusy.com/login.
 
-  1. From terminal/cmd navigate to the root directory of the SDK.
-  2. Invoke: `bundle exec rake`
+Once logged in, navigate to the API Key page and request an API key.
 
-## Initialization
+### Initialization/Authentication
 
-### Authentication
 In order to setup authentication and initialization of the API client, you need the following information.
 
 | Parameter | Description |
@@ -91,9 +46,13 @@ authorization = "Token <your API key>"; # Set Authorization to "Token <your API
 client = Gonebusy::GonebusyClient.new(authorization)
 ```
 
-The added initlization code can be debugged by putting a breakpoint in the ``` Index ``` method and running the project in debug mode by selecting ``` Run -> Debug 'Development: TestApp' ```.
+## How to Test
+
+You can test the generated SDK and the server with automatically generated test
+cases as follows:
 
-![Debug the TestApp](http://apidocs.io/illustration/ruby?step=addCode4&workspaceFolder=GoneBusy%2011-17-16-Ruby&workspaceName=Gonebusy&projectName=gonebusy&gemName=gonebusy&gemVer=0.0.9&initLine=client%2520%253D%2520GonebusyClient.new%2528%2527authorization%2527%2529)
+  1. From terminal/cmd navigate to the root directory of the SDK.
+  2. Invoke: `bundle exec rake`
 
 ## Class Reference
 
@@ -225,7 +184,11 @@ result = bookings.get_bookings(collect)
 
 
 ```ruby
-def cancel_booking_by_id(options = Hash.new); end
+def cancel_booking_by_id(authorization,
+                             id,
+                             cancel_recurring = nil,
+                             date = nil,
+                             end_date = nil); end
 ```
 
 #### Parameters
@@ -234,21 +197,21 @@ def cancel_booking_by_id(options = Hash.new); end
 |-----------|------|-------------|
 | authorization |  ``` Required ```  | A valid API key, in the format 'Token API_KEY' |
 | id |  ``` Required ```  | TODO: Add a parameter description |
+| cancel_recurring |  ``` Optional ```  | When a recurring booking, one of: ['instance', 'all', 'infinite'] |
+| date |  ``` Optional ```  | If a recurring booking, the date of an instance to cancel.  Several formats are supported: '2014-10-31', 'October 31, 2014' |
+| end_date |  ``` Optional ```  | If recurring, cancel up to :end_date or leave blank for infinite booking.  Several formats are supported: '2014-10-31', 'October 31, 2014'. |
 
 
 #### Example Usage
 
 ```ruby
-collect = Hash.new
-
 authorization = 'Authorization'
-collect['authorization'] = authorization
-
 id = 'id'
-collect['id'] = id
-
+cancel_recurring = 'cancel_recurring'
+date = DateTime.now
+end_date = DateTime.now
 
-result = bookings.cancel_booking_by_id(collect)
+result = bookings.cancel_booking_by_id(authorization, id, cancel_recurring, date, end_date)
 
 ```
 
@@ -270,7 +233,9 @@ result = bookings.cancel_booking_by_id(collect)
 
 
 ```ruby
-def update_booking_by_id(options = Hash.new); end
+def update_booking_by_id(authorization,
+                             id,
+                             update_booking_by_id_body = nil); end
 ```
 
 #### Parameters
@@ -279,21 +244,17 @@ def update_booking_by_id(options = Hash.new); end
 |-----------|------|-------------|
 | authorization |  ``` Required ```  | A valid API key, in the format 'Token API_KEY' |
 | id |  ``` Required ```  | TODO: Add a parameter description |
+| update_booking_by_id_body |  ``` Optional ```  | the content of the request |
 
 
 #### Example Usage
 
 ```ruby
-collect = Hash.new
-
 authorization = 'Authorization'
-collect['authorization'] = authorization
-
 id = 'id'
-collect['id'] = id
-
+update_booking_by_id_body = UpdateBookingByIdBody.new
 
-result = bookings.update_booking_by_id(collect)
+result = bookings.update_booking_by_id(authorization, id, update_booking_by_id_body)
 
 ```
 

data/lib/gonebusy/api_helper.rb

@@ -1,149 +1,181 @@
-module Gonebusy
-  class APIHelper
-    # Replaces template parameters in the given url
-    # @param [String] The query string builder to replace the template parameters
-    # @param [Hash] The parameters to replace in the url
-    def self.append_url_with_template_parameters(query_builder, parameters)
-      # perform parameter validation
-      raise ArgumentError, 'Given value for parameter \"query_builder\" is invalid.' unless query_builder.instance_of? String
-
-      # return if there are no parameters to replace
-      if parameters.nil?
-        query_builder
-      else
-        # iterate and append parameters
-        parameters.each do |key, value|
-          replace_value = ''
-
-          if value.nil?
-            replace_value = ''
-          elsif value.instance_of? Array
-            value.map!{|element| CGI.escape(element.to_s)}
-            replace_value = value.join('/')
-          else
-            replace_value = CGI.escape(value.to_s)
-          end
-
-          # find the template parameter and replace it with its value
-          query_builder = query_builder.gsub('{' + key.to_s + '}', replace_value)
-        end
-      end
-      return query_builder
-    end
-
-    # Appends the given set of parameters to the given query string
-    # @param [String] The query string builder to replace the template parameters
-    # @param [Hash] The parameters to append
-    def self.append_url_with_query_parameters(query_builder, parameters)
-      # perform parameter validation
-      raise ArgumentError, 'Given value for parameter \"query_builder\" is invalid.' unless query_builder.instance_of? String
-
-      # return if there are no parameters to replace
-      if parameters.nil?
-        return query_builder
-      else
-        # remove any nil values
-        parameters = parameters.reject { |_key, value| value.nil? }
-
-        # does the query string already has parameters
-        has_params = query_builder.include? '?'
-        separator = has_params ? '&' : '?'
-
-        # append query with separator and parameters and return
-        return query_builder << separator << URI.encode_www_form(parameters)
-      end
-    end
-
-    # Validates and processes the given Url
-    # @param [String] The given Url to process
-    # @return [String] Pre-processed Url as string
-    def self.clean_url(url)
-      # perform parameter validation
-      raise ArgumentError, 'Invalid Url.' unless url.instance_of? String
-
-      # ensure that the urls are absolute
-      matches = url.match(%r{^(https?:\/\/[^\/]+)})
-      raise ArgumentError, 'Invalid Url format.' if matches.nil?
-
-      # get the http protocol match
-      protocol = matches[1]
-      
-      # check if parameters exist
-      index = url.index('?')
-
-      # remove redundant forward slashes
-      query = url[protocol.length...(index != nil ? index : url.length)]
-      query.gsub!(%r{\/\/+}, '/')
-
-      # get the parameters
-      parameters = index != nil ? url[url.index('?')...url.length] : ""
-
-      # return processed url
-      return protocol + query  + parameters
-    end	
-
-    # Parses JSON string.
-    # @param [String] A JSON string.
-    def self.json_deserialize(json)
-      begin
-        return JSON.parse(json)
-      rescue
-        raise TypeError, "Server responded with invalid JSON."
-      end
-    end
-
-    # Form encodes a hash of parameters.
-    # @param [Hash] The hash of parameters to encode.
-    # @return [Hash] A hash with the same parameters form encoded.
-    def self.form_encode_parameters(form_parameters)
-      encoded = Hash.new
-      form_parameters.each do |key, value|
-        encoded.merge!(APIHelper.form_encode value, key)
-      end 
-      return encoded
-    end
-
-    # Form encodes an object.
-    # @param [Dynamic] An object to form encode.
-    # @param [String] The name of the object.
-    # @return [Hash] A form encoded representation of the object in the form of a hash.
-    def self.form_encode(obj, instance_name)
-      retval = Hash.new
-
-      # If this is a structure, resolve it's field names.
-      if obj.kind_of? BaseModel
-        obj = obj.to_hash
-      end
-      
-      # Create a form encoded hash for this object.
-      if obj == nil
-        nil         
-      elsif obj.instance_of? Array
-        obj.each_with_index do |value, index|
-          retval.merge!(APIHelper.form_encode(value, instance_name + "[" + index.to_s + "]"))
-        end
-      elsif obj.instance_of? Hash
-        obj.each do |key, value|
-          retval.merge!(APIHelper.form_encode(value, instance_name + "[" + key + "]"))
-        end
-      else
-        retval[instance_name] = obj
-      end
-      return retval
-    end
-  end
-end
-
-# extend types to support to_bool
-module ToBoolean
-  def to_bool
-    return true if self == true || self.to_s.strip =~ /^(true|yes|y|1)$/i
-    return false
-  end
-end
-
-class NilClass; include ToBoolean; end
-class TrueClass; include ToBoolean; end
-class FalseClass; include ToBoolean; end
-class Numeric; include ToBoolean; end
-class String; include ToBoolean; end
+# This file was automatically generated by APIMATIC v2.0 ( https://apimatic.io ).
+
+module Gonebusy
+  class APIHelper
+    # Serializes an array parameter (creates key value pairs)
+    # @param [String] The name of the parameter
+    # @param [Array] The value of the parameter
+    # @param [String] The format of the serialization
+    def self.serialize_array(key, array, formatting: 'indexed')
+      tuples = []
+
+      if formatting == 'unindexed'
+        tuples += array.map { |element| ["#{key}[]", element] }
+      elsif formatting == 'indexed'
+        tuples += array.map.with_index { |element, index| ["#{key}[#{index}]", element] }
+      elsif formatting == 'plain'
+        tuples += array.map { |element| [key, element] }
+      else
+        raise ArgumentError, 'Invalid format provided.'
+      end
+      tuples
+    end
+
+    # Replaces template parameters in the given url
+    # @param [String] The query string builder to replace the template parameters
+    # @param [Hash] The parameters to replace in the url
+    def self.append_url_with_template_parameters(query_builder, parameters)
+      # perform parameter validation
+      raise ArgumentError, 'Given value for parameter \"query_builder\" is invalid.' unless query_builder.instance_of? String
+
+      # return if there are no parameters to replace
+      return query_builder if parameters.nil?
+
+      # iterate and append parameters
+      parameters.each do |key, value|
+        replace_value = ''
+
+        if value.nil?
+          replace_value = ''
+        elsif value.instance_of? Array
+          value.map! { |element| CGI.escape(element.to_s) }
+          replace_value = value.join('/')
+        else
+          replace_value = CGI.escape(value.to_s)
+        end
+
+        # find the template parameter and replace it with its value
+        query_builder = query_builder.gsub('{' + key.to_s + '}', replace_value)
+      end
+      query_builder
+    end
+
+    # Appends the given set of parameters to the given query string
+    # @param [String] The query string builder to add the query parameters to
+    # @param [Hash] The parameters to append
+    # @param [String] The format of array parameter serialization
+    def self.append_url_with_query_parameters(query_builder, parameters, array_serialization: 'indexed')
+      # perform parameter validation
+      raise ArgumentError, 'Given value for parameter \"query_builder\" is invalid.' unless query_builder.instance_of? String
+
+      # return if there are no parameters to replace
+      return query_builder if parameters.nil?
+
+      parameters.each do |key, value|
+        seperator = (query_builder.include? '?') ? '&' : '?'
+        if not value.nil?
+          if value.instance_of? Array
+            value.compact!
+            if array_serialization == 'csv'
+              query_builder += "#{seperator}#{key}=#{value.map { |element| CGI.escape(element.to_s) }.join(',')}"
+            elsif array_serialization == 'psv'
+              query_builder += "#{seperator}#{key}=#{value.map { |element| CGI.escape(element.to_s) }.join('|')}"
+            elsif array_serialization == 'tsv'
+              query_builder += "#{seperator}#{key}=#{value.map { |element| CGI.escape(element.to_s) }.join('\t')}"
+            else
+              query_builder += "#{seperator}#{APIHelper.serialize_array(key, value, formatting: array_serialization).
+                map { |k, v| "#{k}=#{CGI.escape(v.to_s)}" }.join('&')}"
+            end
+          else
+            query_builder += "#{seperator}#{key}=#{CGI.escape(value.to_s)}"
+          end
+        end
+      end
+      query_builder
+    end
+
+    # Validates and processes the given Url
+    # @param [String] The given Url to process
+    # @return [String] Pre-processed Url as string
+    def self.clean_url(url)
+      # perform parameter validation
+      raise ArgumentError, 'Invalid Url.' unless url.instance_of? String
+
+      # ensure that the urls are absolute
+      matches = url.match(%r{^(https?:\/\/[^\/]+)})
+      raise ArgumentError, 'Invalid Url format.' if matches.nil?
+
+      # get the http protocol match
+      protocol = matches[1]
+
+      # check if parameters exist
+      index = url.index('?')
+
+      # remove redundant forward slashes
+      query = url[protocol.length...(!index.nil? ? index : url.length)]
+      query.gsub!(%r{\/\/+}, '/')
+
+      # get the parameters
+      parameters = !index.nil? ? url[url.index('?')...url.length] : ''
+
+      # return processed url
+      protocol + query + parameters
+    end
+
+    # Parses JSON string.
+    # @param [String] A JSON string.
+    def self.json_deserialize(json)
+      return JSON.parse(json)
+    rescue
+      raise TypeError, 'Server responded with invalid JSON.'
+    end
+
+    # Removes elements with empty values from a hash.
+    # @param [Hash] The hash to clean.
+    def self.clean_hash(hash)
+      hash.delete_if { |_key, value| value.to_s.strip.empty? }
+    end
+
+    # Form encodes a hash of parameters.
+    # @param [Hash] The hash of parameters to encode.
+    # @return [Hash] A hash with the same parameters form encoded.
+    def self.form_encode_parameters(form_parameters)
+      encoded = {}
+      form_parameters.each do |key, value|
+        encoded.merge!(APIHelper.form_encode(value, key))
+      end
+      encoded
+    end
+
+    # Form encodes an object.
+    # @param [Dynamic] An object to form encode.
+    # @param [String] The name of the object.
+    # @return [Hash] A form encoded representation of the object in the form of a hash.
+    def self.form_encode(obj, instance_name)
+      retval = {}
+
+      # If this is a structure, resolve it's field names.
+      obj = obj.to_hash if obj.is_a? BaseModel
+
+      # Create a form encoded hash for this object.
+      if obj.nil?
+        nil
+      elsif obj.instance_of? Array
+        obj.each_with_index do |value, index|
+          retval.merge!(APIHelper.form_encode(value, instance_name + '[' + index.to_s + ']'))
+        end
+      elsif obj.instance_of? Hash
+        obj.each do |key, value|
+          retval.merge!(APIHelper.form_encode(value, instance_name + '[' + key + ']'))
+        end
+      else
+        retval[instance_name] = obj
+      end
+      retval
+    end
+  end
+end
+
+# extend types to support to_bool
+module ToBoolean
+  def to_bool
+    return true if self == true || self.to_s.strip =~ /^(true|yes|y|1)$/i
+    return false
+  end
+end
+
+class NilClass; include ToBoolean; end
+class TrueClass; include ToBoolean; end
+class FalseClass; include ToBoolean; end
+class Numeric; include ToBoolean; end
+class String; include ToBoolean; end