uber-ruby 0.9.0 → 0.10.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    YmFhZmY0OGRmMDc0MDNiYTJjYTY0NjA0MjNhNDJhMWM4MjlmMmQzNg==
-  data.tar.gz: !binary |-
-    YzU0ZjU2YmQzNjEzNjYxZTJhYTM5NzQ5YjVhNGIzNTBiNWI4MTIxMA==
+SHA1:
+  metadata.gz: afcf13093d0201d8e6aa5184b284a855f26444f2
+  data.tar.gz: 579ce6c5fa4105bf687252d246183717757379aa
 SHA512:
-  metadata.gz: !binary |-
-    YzhiYzEzZmYzZDc1M2FlNDliZjg1MjVhNWZiZjYwYmI2OGQ2MTc2YjJhYmEz
-    ZDQxNjhjMmVmNGI1ZTYwMmQxNGI3MDAzMDdlM2ZhNWUzZGFlMGI3ZjZiMDEx
-    NzQ1MTUyNWNlODRiY2QxOWIyNmQ3YzY3NDQ5ODBiZTk3OWRiNjI=
-  data.tar.gz: !binary |-
-    MGI0Yjg2ZDlhYjkzZTgyOGU2ZjcxMDJhNTZmNTdlNTU5NDJhNzU5ZDYwMDg5
-    ZGVhMDUyYzE0OTg5ZWZjYTJhMTU4NTM1YjE5ZGNhYWU0YjAyY2I1MTRkYmYz
-    ZmM2NWI0YzdkYzcxYzM5MTEyNTgxZmY5MTAzZDVhNjNiMDg4ZTk=
+  metadata.gz: d952ae18bf90371fa49e9810859bc44fea3d0421de5372c1bf80f455f543fbb3665eb0ae5941065df33c095d52926e85e1d40a33bbea03cd41029239e0639fb3
+  data.tar.gz: b1b9d1ec5e85eee3f5ac9ea666cacb130449c1127e7157a9277e66ff3ee050837da574996647787b6fa171e21ef1797023227ea5caaee34a106526a81d90d8ed

data/README.md

@@ -327,7 +327,128 @@ trip.duration #=> 0
 ```
 More details can be found [here](https://developer.uber.com/docs/drivers/references/api/v1/partners-trips-get).
 
+## Deliveries API
+[Deliveries API]() lets you and your customer track the exact location of your delivery from any device. 
+> OAuth 2.0 bearer token with the delivery scope 
 
+We provide this under namespace of `client.deliveries`. Besides OAuth, you can get bearer token with `delivery` scope via __client_credentials__ workflow, follow this [guide](https://developer.uber.com/docs/deliveries/guides/authentication#client-credentials-flow).
+
+```ruby
+client = Uber::Client.new do |config|
+  config.server_token  = "YOUR_SERVER_TOKEN"
+  config.client_id     = "YOUR_CLIENT_ID"
+  config.client_secret = "YOUR_CLIENT_SECRET"
+  config.bearer_token  = "USER_ACCESS_TOKEN"
+end
+```
+
+
+### List deliveries
+It retrieves a list of all deliveries
+  
+
+```ruby
+deliveries = client.deliveries.list #=> Array of Uber::Delivery::Delivery
+```
+More details can be found [here](https://developer.uber.com/docs/deliveries/references/api/v1/deliveries-get)
+
+### Create a delivery
+It allows a delivery to be requested given the delivery information and quote ID
+
+```ruby
+delivery = client.deliveries.add_delivery({quote_id: 'KEBjNGUxNjhlZmNmMD...', .. })
+delivery.quote_id #=> 'KEBjNGUxNjhlZmNmMD...'
+```
+More details and parameters can be found [here](https://developer.uber.com/docs/deliveries/references/api/v1/deliveries-post)
+
+### Create delivery quote
+Generate a delivery quote, given a pickup and dropoff location. On-demand and scheduled delivery quotes will be returned.
+
+```ruby
+quotes = client.deliveries.add_quote({ "pickup" => { "location" => { ... } }, 
+                                       "dropoff" => { "location" => { ... } } )
+# returns array of Uber::Delivery::Quote containing all On-demand and scheduled delivery quotes
+quotes.size #=> 4
+quotes[0].fee #=> 5.42
+```
+More details can be found [here](https://developer.uber.com/docs/deliveries/references/api/v1/deliveries-quote-post)
+
+### Retrieve a delivery information
+Get the status of an ongoing delivery
+
+```ruby
+delivery = client.deliveries.retrieve('8b58bc58-7352-4278-b569-b5d24d8e3f76') #=> Uber::Delivery::Delivery
+delivery.currency_code #=> "USD"
+delivery.delivery_id #=> '8b58bc58-7352-4278-b569-b5d24d8e3f76'
+delivery.fee #=> 5.0
+```
+More details can be found [here](https://developer.uber.com/docs/deliveries/references/api/v1/deliveries-delivery_id-get)
+
+### Retrieve receipt for a delivery
+```ruby
+receipt = client.deliveries.receipt('8b58bc58-7352-4278-b569-b5d24d8e3f76') #=> Uber::Delivery::Receipt
+receipt.delivery_id #=> '8b58bc58-7352-4278-b569-b5d24d8e3f76'
+receipt.total_fee #=> 6.17
+receipt.charges #=> hash of charges
+```
+More details can be found [here](https://developer.uber.com/docs/deliveries/references/api/v1/deliveries-delivery_id-receipt-get)
+
+### Get delivery ratings
+Retrieve the available ratings for a delivery.
+
+```ruby
+ratings = client.deliveries.ratings('8b58bc58-7352-4278-b569-b5d24d8e3f76')
+# Array of Uber::Delivery::Rating
+ratings.size #=> 2
+ratings[0].waypoint #=> 'pickup'
+```
+More details can be found [here](https://developer.uber.com/docs/deliveries/references/api/v1/deliveries-delivery_id-ratings-get)
+
+### Submit a rating
+Submit a rating for a delivery.
+
+```ruby
+status = client.deliveries.add_rating('8b58bc58-7352-4278-b569-b5d24d8e3f76',
+                                          {"waypoint"=>"dropoff",
+                                           "rating_type"=>"binary",
+                                           "rating_value"=>0,
+                                           "tags"=>["courier_not_on_time", "delivery_in_good_condition"],
+                                           "comments"=>"Courier was not professionally dressed."})
+# Returns the status code, with no content
+status #=> 204                                           
+```
+More details can be found [here](https://developer.uber.com/docs/deliveries/references/api/v1/deliveries-delivery_id-ratings-post)
+
+### Get rating tags
+Retrieve the available rating tags for a delivery
+
+```ruby
+tags = client.deliveries.rating_tags('8b58bc58-7352-4278-b569-b5d24d8e3f76')
+# Array of Uber::Deliery::RatingTag
+tags.size #=> 2
+tags[0].waypoint #=> 'pickup'
+tags.tags #=> Array of rating tags for delivery 
+```
+More details can be found [here](https://developer.uber.com/docs/deliveries/references/api/v1/deliveries-delivery_id-rating_tags-get)
+
+### Cancel a delivery
+Cancel an existing delivery.
+
+```ruby
+status = client.deliveries.cancel('8b58bc58-7352-4278-b569-b5d24d8e3f76')
+status #=> 204
+```
+More details can be found [here](https://developer.uber.com/docs/deliveries/references/api/v1/deliveries-delivery_id-cancel-post)
+
+### Get service regions
+Returns all regions where UberRUSH is available.
+
+```ruby
+regions = client.deliveries.regions
+# Array of Uber::Delivery::Region
+regions[0].city #=> 'San Francisco'
+```
+More details can be found [here](https://developer.uber.com/docs/deliveries/references/api/v1/deliveries-regions-get)
 
 ## Contributors
 

data/lib/uber/api.rb

@@ -8,6 +8,7 @@ require 'uber/api/reminders.rb'
 require 'uber/api/requests'
 require 'uber/api/places'
 require 'uber/api/partners'
+require 'uber/api/deliveries'
 
 module Uber
   module API

data/lib/uber/api/deliveries.rb

@@ -0,0 +1,60 @@
+require 'uber/arguments'
+require 'uber/api_request'
+require 'uber/models/delivery'
+
+module Uber
+  module API
+    module Deliveries
+      include Uber::Utils
+
+      def list(*args)
+        arguments = Uber::Arguments.new(args)
+        perform_with_objects(:get, "/v1/deliveries", arguments.options, Delivery::Delivery, self.client)
+      end
+
+      def add_delivery(*args)
+        arguments = Uber::Arguments.new(args)
+        perform_with_object(:post, "/v1/deliveries", arguments.options, Delivery::Delivery, self.client)
+      end
+
+      def add_quote(*args)
+        arguments = Uber::Arguments.new(args)
+        perform_with_objects(:post, "/v1/deliveries/quote", arguments.options, Delivery::Quote, self.client)
+      end
+
+      def retrieve(delivery_id)
+        perform_with_object(:get, "/v1/deliveries/#{delivery_id}", {}, Delivery::Delivery, self.client)
+      end
+
+      def receipt(delivery_id)
+        delivery_id = delivery_id.is_a?(Delivery::Delivery) ? delivery_id.delivery_id : delivery_id
+        perform_with_object(:get, "/v1/deliveries/#{delivery_id}/receipt", {}, Delivery::Receipt, self.client)
+      end
+
+      def ratings(delivery_id)
+        delivery_id = delivery_id.is_a?(Delivery::Delivery) ? delivery_id.delivery_id : delivery_id
+        perform_with_objects(:get, "/v1/deliveries/#{delivery_id}/ratings", {}, Delivery::Rating, self.client)
+      end
+
+      def add_rating(delivery_id, *args)
+        delivery_id = delivery_id.is_a?(Delivery::Delivery) ? delivery_id.delivery_id : delivery_id
+        arguments = Uber::Arguments.new(args)
+        perform_without_object(:post, "/v1/deliveries/#{delivery_id}/rating", arguments.options, self.client)
+      end
+
+      def rating_tags(delivery_id)
+        delivery_id = delivery_id.is_a?(Delivery::Delivery) ? delivery_id.delivery_id : delivery_id
+        perform_with_objects(:get, "/v1/deliveries/#{delivery_id}/rating_tags", {}, Delivery::RatingTag, self.client)
+      end
+
+      def cancel(delivery_id)
+        delivery_id = delivery_id.is_a?(Delivery::Delivery) ? delivery_id.delivery_id : delivery_id
+        perform_without_object(:post, "/v1/deliveries/#{delivery_id}/cancel", {}, self.client)
+      end
+
+      def regions
+        perform_with_objects(:get, "/v1/deliveries/regions", {}, Delivery::Region, self.client)
+      end
+    end
+  end
+end

data/lib/uber/api_request.rb

@@ -30,9 +30,14 @@ module Uber
     # @param klass [Class]
     # @return [Array]
     def perform_with_objects(klass)
-      perform.values.flatten.collect do |element|
+      ((perform.values.find { |v| v.is_a?(Array) }) || []).collect do |element|
         klass.new(element)
       end
     end
+
+    # @return status_code [Integer]
+    def perform_without_object
+      @client.send(@request_method, @path, @options).status
+    end
   end
 end

data/lib/uber/client.rb

@@ -120,6 +120,10 @@ module Uber
     def partners
       @partners ||= Uber::Partner::Client.new self
     end
+
+    def deliveries
+      @deliveries ||= Uber::Delivery::Client.new self
+    end
     private
 
     # Ensures that all credentials set during configuration are
@@ -180,5 +184,14 @@ module Uber
       end
     end
   end
+  module Delivery
+    class Client
+      include Uber::API::Deliveries
+      attr_reader :client
+      def initialize(client)
+        @client = client
+      end
+    end
+  end
 
 end

data/lib/uber/models/delivery.rb

@@ -0,0 +1,6 @@
+require 'uber/models/delivery/delivery'
+require 'uber/models/delivery/quote'
+require 'uber/models/delivery/rating'
+require 'uber/models/delivery/rating_tag'
+require 'uber/models/delivery/receipt'
+require 'uber/models/delivery/region'

data/lib/uber/models/delivery/delivery.rb

@@ -0,0 +1,13 @@
+module Uber
+  module Delivery
+    class Delivery < Base
+      attr_accessor :courier, :created_at, :currency_code, :delivery_id,
+                    :dropoff, :fee, :items, :order_reference_id, :pickup, :quote_id,
+                    :status, :tracking_url, :batch
+
+      def created_at
+        @created_at && ::Time.at(@created_at)
+      end
+    end
+  end
+end

data/lib/uber/models/delivery/quote.rb

@@ -0,0 +1,16 @@
+module Uber
+  module Delivery
+    class Quote < Base
+      attr_accessor :quote_id, :estimated_at, :expires_at, :fee, :currency_code,
+                    :pickup_eta, :dropoff_eta
+
+      def estimated_at
+        @estimated_at && ::Time.at(@estimated_at)
+      end
+
+      def expires_at
+        @expires_at && ::Time.at(@expires_at)
+      end
+    end
+  end
+end

data/lib/uber/models/delivery/rating.rb

@@ -0,0 +1,7 @@
+module Uber
+  module Delivery
+    class Rating < Base
+      attr_accessor :waypoint, :rating_type, :rating_value, :tags, :comments
+    end
+  end
+end

data/lib/uber/models/delivery/rating_tag.rb

@@ -0,0 +1,7 @@
+module Uber
+  module Delivery
+    class RatingTag < Base
+      attr_accessor :waypoint, :tags
+    end
+  end
+end

data/lib/uber/models/delivery/receipt.rb

@@ -0,0 +1,7 @@
+module Uber
+  module Delivery
+    class Receipt < Base
+      attr_accessor :charges, :charge_adjustments, :delivery_id, :currency_code, :total_fee
+    end
+  end
+end

data/lib/uber/models/delivery/region.rb

@@ -0,0 +1,7 @@
+module Uber
+  module Delivery
+    class Region < Base
+      attr_accessor :city, :country, :type, :features
+    end
+  end
+end

data/lib/uber/utils.rb

@@ -20,5 +20,13 @@ module Uber
       request = Uber::ApiRequest.new(client, request_method, path, options)
       request.perform_with_objects(klass)
     end
+
+    # @param request_method [Symbol]
+    # @param path [String]
+    # @param options [Hash]
+    def perform_without_object(request_method, path, options, client=self)
+      request = Uber::ApiRequest.new(client, request_method, path, options)
+      request.perform_without_object
+    end
   end
 end

data/lib/uber/version.rb

@@ -1,7 +1,7 @@
 module Uber
   class Version
     MAJOR = 0
-    MINOR = 9
+    MINOR = 10
     PATCH = 0
 
     class << self

data/uber-ruby.gemspec

@@ -27,5 +27,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec",    "~> 3.3.0"
 
   spec.add_dependency 'faraday', '~> 0.9.0'
-  spec.add_dependency 'json', '~> 1.8'
+  spec.add_dependency 'json'
 end

metadata

@@ -1,99 +1,99 @@
 --- !ruby/object:Gem::Specification
 name: uber-ruby
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Dingding Ye
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-23 00:00:00.000000000 Z
+date: 2017-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.21.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.21.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.3.0
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.0
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '0'
 description: A Ruby interface to the Uber API.
 email:
 - yedingding@gmail.com
@@ -107,6 +107,7 @@ files:
 - lib/uber.rb
 - lib/uber/api.rb
 - lib/uber/api/activities.rb
+- lib/uber/api/deliveries.rb
 - lib/uber/api/me.rb
 - lib/uber/api/partners.rb
 - lib/uber/api/places.rb
@@ -122,6 +123,13 @@ files:
 - lib/uber/client.rb
 - lib/uber/error.rb
 - lib/uber/models/activity.rb
+- lib/uber/models/delivery.rb
+- lib/uber/models/delivery/delivery.rb
+- lib/uber/models/delivery/quote.rb
+- lib/uber/models/delivery/rating.rb
+- lib/uber/models/delivery/rating_tag.rb
+- lib/uber/models/delivery/receipt.rb
+- lib/uber/models/delivery/region.rb
 - lib/uber/models/estimate.rb
 - lib/uber/models/map.rb
 - lib/uber/models/partner.rb
@@ -153,17 +161,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: 1.3.5
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: The Uber Ruby Gem.