onfleet-ruby 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9795a4d38c0dd2a83ec469fec22fecac5392548b
-  data.tar.gz: 529fabb99a08bee55a2d95a63e971009156c7934
+  metadata.gz: f1d19ee4307f4f027c05f2581baae87b5a52c1d0
+  data.tar.gz: a88178b746ab81416c9919b3df3c914cc7dca388
 SHA512:
-  metadata.gz: cc259a233c2b0bbbac7aaf767a0830100db8a0d98dec7207ca24e2ca1430f424d918cbaf5faf9df94fd27f9f8228a2c8bbda3febe937329bec57f8d71cb2261b
-  data.tar.gz: c52c2ed5675e153470b524dfeca72aa0cf323637a248d5965e1a3adeb0aecd34b09d3207ed5738ffec3512ac83f85eb63dd59c1ac3e8fc2fc6dbeb93d8ac0310
+  metadata.gz: 1a6f0b564028363c31263ec927caf5e84777bec52f3aee8c830e786cca80283bc01ed0004970ffbaf138fd65ae7789ed7b002e75c71ef52c0b146bfd0a9d478b
+  data.tar.gz: 721408e9ac056dc81ae3acdf62bbbf3c20530dc56c36c5f9aaa8a63f6d7b1b45aae8a5191ac65b735718640b69e1ce2fbc838c91388c398205c2511ddf79c2b4

data/README.md

@@ -61,6 +61,7 @@ delegatee.country # => "US"
 | name        | string | The administrator’s complete name. |
 | email       | string | The administrator’s email address. |
 | phone     | string | (Optional) The administrator's E.164-formatted phone number. |
+| metadata  | array  | (Optional) Any associated metadata |
 
 **Create**
 
@@ -95,7 +96,8 @@ Worker
 | name        | string | The workers complete name. |
 | phone       | string | The worker's phone number. |
 | teams     | string Array | One or more team IDs of which the worker is a member.|
-| vehicle     | obect | (Optional) The worker’s vehicle, providing no vehicle details is interpreted as the worker being on foot. |
+| vehicle     | object | (Optional) The worker’s vehicle, providing no vehicle details is interpreted as the worker being on foot. |
+| metadata    | array  | (Optional) Any associated metadata |
 
 Vehicle
 
@@ -164,6 +166,7 @@ Destination
 | address        | object | The destination’s street address details. |
 | location       | array | (Optional) The `[ longitude, latitude ]` geographic coordinates. If missing, the API will geocode based on the `address` details provided. Note that geocoding may slightly modify the format of the address properties. |
 | notes     | string | (Optional) Notes for the destination |
+| metadata  | array  | (Optional) Any associated metadata |
 
 Address
 
@@ -181,7 +184,6 @@ Address
 
 
 
-
 **Create**
 ```ruby
 destination = Onfleet::Destination.create({address: {unparsed: '200 12th st, 94103, ca'} })
@@ -204,6 +206,7 @@ Onfleet::Destination('DEST_ID')
 | notes     | string | (Optional) Notes for the recipient. |
 | skip_sms_notifications     | boolean | (Optional) To disable sms notification. Defaults to `false` |
 | skip_phone_number_verificaton     | boolean | (Optional) Whether to skip validation of the phone number. |
+| metadata  | array  | (Optional) Any associated metadata |
 
 **Create**
 ```ruby
@@ -239,11 +242,11 @@ rec.name = "John Doe"
 rec = Onfleet::Recipient.find('phone', '4155556789')
 ```
 
-##Tasks
+## Tasks
 | Name        | Type   | Description  |
 | ----------- |--------| --------------|
-| destination     | string | `ID` of the destination. |
-| recipients     | string array | An array containing zero or one IDs of the task's recipients |
+| destination     | string or hash | `ID` of the destination, or the Destination data itself |
+| recipients     | array of string or hash | An array containing zero or one IDs of the task's recipients; alternately, an array containing Recipient data as entries |
 | merchant        | string | (Optional) `ID` of merchant organization. |
 | executor       | string | (Optional) `ID` of the executor organization. |
 | complete_after     | number | (Optional)  A timestamp for the earliest time the task should be completed. |
@@ -252,12 +255,29 @@ rec = Onfleet::Recipient.find('phone', '4155556789')
 | dependencies     | string array | (Optional) One or more IDs of tasks which must be completed prior to this task. |
 | notes     | notes | (Optional) Notes for the task. |
 | auto_assign     | object | (Optional) The automatic assignment options for the newly created task. See above for exact object structure and allowed values. |
+| metadata  | array  | (Optional) Any associated metadata |
 
 **Create**
 ```ruby
 # First Create a destination and Recipient
 # Then create the task
-task = Onfleet::Task.create({recipient: ['REC_ID'], destination: 'DEC_ID' })
+task = Onfleet::Task.create({recipients: ['REC_ID'], destination: 'DEC_ID' })
+
+# Alternatively, create the Destination and Recipient in a single call to Onfleet
+# If a recipient exists for the phone number, it will be updated with the new information
+another_task = Onfleet::Task.create(
+  destination: {
+      address: {
+          unparsed: "123 Smith St"
+      },
+      notes: "Some destination notes"
+  },
+  recipients: [{
+      name: "Foo Bar",
+      phone: "987-654-3210",
+      notes: "Some recipient notes"
+  }]
+)
 ```
 
 **Update**
@@ -288,7 +308,21 @@ Onfleet::Task.list({state: 0}) # => returns all tasks with state 0, see official
 Currently not supported
 
 
-##Error Handling
+## Metadata
+| Name        | Type   | Description  |
+| ----------- |--------| --------------|
+| name     | string | the name of the property |
+| type     | string | The type of the property. Must be one of [ ‘boolean’, ‘number’, ‘string’, ‘object’, ‘array’ ] |
+| subtype  | string | (Optional) Required only for entries of type array, used for future visualization purposes. Must be one of [ ‘boolean’, ‘number’, ‘string’, ‘object’ ]. |
+| value    | string | The value of the property. The JSON type must match the type (and subtype) provided for the entry. |
+
+```ruby
+# Returns an array with entities matching the metadata query
+# Any entity supporting metadata can be queried (eg: Admins, Workers, Tasks, Destinations, Recipients)
+tasks = Onfleet::Task.query_by_metadata([{name: "property", type: "string", value: "abc"}])
+```
+
+## Error Handling
 ```ruby
 begin
   # perform onfleet api requests

data/lib/onfleet-ruby.rb

@@ -20,7 +20,10 @@ require 'onfleet-ruby/actions/update'
 require 'onfleet-ruby/actions/get'
 require 'onfleet-ruby/actions/list'
 require 'onfleet-ruby/actions/delete'
-
+<<<<<<< HEAD
+=======
+require 'onfleet-ruby/actions/query_metadata'
+>>>>>>> 5c063de65d354e63cb5ac4f7589fbb9c1ae99c5a
 
 # Resources
 require 'onfleet-ruby/onfleet_object'

data/lib/onfleet-ruby/actions/query_metadata.rb

@@ -0,0 +1,17 @@
+module Onfleet
+  module Actions
+    module QueryMetadata
+      module ClassMethods
+        def query_by_metadata metadata
+          api_url = "#{self.api_url}/metadata"
+          response = Onfleet.request(api_url, :post, metadata)
+          response.map { |item| Util.constantize("#{self}").new(item) } if response.is_a? Array
+        end
+      end
+
+      def self.included base
+        base.extend(ClassMethods)
+      end
+    end
+  end
+end

data/lib/onfleet-ruby/admin.rb

@@ -5,7 +5,7 @@ module Onfleet
     include Onfleet::Actions::Update
     include Onfleet::Actions::List
     include Onfleet::Actions::Delete
-
+    include Onfleet::Actions::QueryMetadata
 
     def self.api_url
       '/admins'

data/lib/onfleet-ruby/destination.rb

@@ -3,7 +3,7 @@ module Onfleet
     include Onfleet::Actions::Create
     include Onfleet::Actions::Save
     include Onfleet::Actions::Get
-
+    include Onfleet::Actions::QueryMetadata
 
     def self.api_url
       '/destinations'

data/lib/onfleet-ruby/onfleet_object.rb

@@ -57,7 +57,7 @@ module Onfleet
 
       def parse_onfleet_obj obj
         if obj.is_a?(OnfleetObject)
-          if obj.is_a?(Destination) || obj.is_a?(Recipient) || obj.is_a?(Task)
+          if obj.respond_to?('id') && obj.id && (obj.is_a?(Destination) || obj.is_a?(Recipient) || obj.is_a?(Task))
              obj.id
           else
             obj.attributes

data/lib/onfleet-ruby/recipient.rb

@@ -5,6 +5,7 @@ module Onfleet
     include Onfleet::Actions::Save
     include Onfleet::Actions::Find
     include Onfleet::Actions::Get
+    include Onfleet::Actions::QueryMetadata
 
     def self.api_url
       "/recipients"

data/lib/onfleet-ruby/task.rb

@@ -6,7 +6,7 @@ module Onfleet
     include Onfleet::Actions::Get
     include Onfleet::Actions::List
     include Onfleet::Actions::Delete
-
+    include Onfleet::Actions::QueryMetadata
 
     def self.api_url
       '/tasks'

data/lib/onfleet-ruby/worker.rb

@@ -6,7 +6,7 @@ module Onfleet
     include Onfleet::Actions::Save
     include Onfleet::Actions::Update
     include Onfleet::Actions::Delete
-
+    include Onfleet::Actions::QueryMetadata
 
     def self.api_url
       '/workers'

data/onfleet-ruby.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'onfleet-ruby'
-  s.version     = '0.1.1'
+  s.version     = '0.1.2'
   s.date        = '2015-08-03'
   s.summary     = "Onfleet ruby api"
   s.description = "To interact with Onfleet's API"

data/spec/spec_helper.rb

@@ -1,2 +1,2 @@
-require 'onfleet'
-require File.expand_path('./test_data', __FILE__)
+require 'onfleet-ruby'
+require File.expand_path('../test_data', __FILE__)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: onfleet-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Nick Wargnier
@@ -14,34 +14,34 @@ dependencies:
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.3.0
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.3.0
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
 description: To interact with Onfleet's API
@@ -50,8 +50,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
+- ".gitignore"
+- ".rspec"
 - Gemfile
 - README.md
 - lib/onfleet-ruby.rb
@@ -60,6 +60,7 @@ files:
 - lib/onfleet-ruby/actions/find.rb
 - lib/onfleet-ruby/actions/get.rb
 - lib/onfleet-ruby/actions/list.rb
+- lib/onfleet-ruby/actions/query_metadata.rb
 - lib/onfleet-ruby/actions/save.rb
 - lib/onfleet-ruby/actions/update.rb
 - lib/onfleet-ruby/address.rb
@@ -91,17 +92,17 @@ 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.4.5
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Onfleet ruby api