uber-ruby 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c4c9bf4cb4b8f0ced763b3702bb943a90ae36327
-  data.tar.gz: 2e123aa2989f454b0f0e3e88a908e11e38aa7c95
+  metadata.gz: 8060589837d67de3722ccf0abed7a4d7746b71f6
+  data.tar.gz: 1c687e372cfcf81e0c672c170433b89911489286
 SHA512:
-  metadata.gz: c9ec68f21a3ebb754e11df5d7559d222dfcb41552578697583110299dfa1c1130c45bf66afc23ca40bb8d6780fbd5babcc04f543414d0267d8a1a814dadd7d82
-  data.tar.gz: d3c849532fe23d3f62ac85493fb4f92f1c6747c7aee8c88afe89f8162f316419960ffd376b643d7c089c659ca103e832e3d2b24002c2a0cc4001384c52dae9c0
+  metadata.gz: 4fe8b29d05132829972d2a6264e070467ef6dd3a6af3bd864e4aa9af6057ee36eaf941c991d013a3a8fed2bb1a969de4c1071bcf2bcfd2be0e03cf99de546a4f
+  data.tar.gz: 85da92e48dcb0fa4b60de2b1d4b3b6ed2307dc6d2b81a2422646733266f4678433b15f85cb29c674ae9ff2567477c38ee48ca4074f24be4181228f0dd8f44a54

data/README.md

@@ -258,6 +258,60 @@ reminder.delete_reminder 'rem1'
 #=> Uber::Reminder
 ```
 
+## Drivers API
+[Drivers API](https://developer.uber.com/docs/drivers/introduction) lets you build services and solutions that make the driver experience more productive and rewarding. With the driver's permission, you can use trip data, earnings, ratings and more to shape the future of the on-demand economy.   
+
+We provide this under namespace of `client.partners`
+
+### Driver details
+It returns the profile of the authenticated driver.
+> OAuth 2.0 bearer token with a partner.accounts scope.   
+ 
+```ruby
+driver = client.partners.me
+driver.first_name #=> 'John'
+driver.last_name #=> 'Driver'
+driver.promo_code #=> 'join_john_on_uber'
+```
+More details can be found [here](https://developer.uber.com/docs/drivers/references/api/v1/partners-me-get).
+
+### Earnings details
+It returns an array of payments for the given driver. Payments are available at this endpoint in near real-time.
+> OAuth 2.0 bearer token with scope partner.payments
+
+```ruby
+earnings = client.partners.payments 
+# client.partners.earnings is also supported
+earnings.count #=> 5
+earnings.payments #=> Array of Uber::Partner::Payment
+payment = earnings.payments.first
+payment.category #=> 'fare'
+payment.cash_collected #=> 7.63
+payment.currency_code #=> 'USD'
+payment.event_time #=> 2016-11-12 10:29:28 UTC
+
+# Using params:
+earnings = client.partners.payments(:offset => 1, :limit => 2)
+```
+More details can be found [here](https://developer.uber.com/docs/drivers/references/api/v1/partners-payments-get).
+
+### Trips details
+It returns an array of trips for the authenticated driver.    
+> OAuth 2.0 bearer token with the partner.trips.
+
+```ruby
+trips = client.partners.trips 
+trips.count #=> 1
+trips.offset #=> 0
+trips.trips #=> Array of Uber::Partner::Trip
+trip = trips.trips.first
+trip.distance #=> 0
+trip.status #=> 'driver_canceled'
+trip.duration #=> 0
+```
+More details can be found [here](https://developer.uber.com/docs/drivers/references/api/v1/partners-trips-get).
+
+
 
 ## Contributors
 
@@ -266,7 +320,7 @@ reminder.delete_reminder 'rem1'
 
 ## Contributing
 
-1. Fork it ( http://github.com/<my-github-username>/uber-ruby/fork )
+1. Fork it ( http://github.com/sishen/uber-ruby/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/uber/api.rb

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

data/lib/uber/api/partners.rb

@@ -0,0 +1,26 @@
+require 'uber/arguments'
+require 'uber/api_request'
+require 'uber/models/partner'
+
+module Uber
+  module API
+    module Partners
+      include Uber::Utils
+      def me
+        perform_with_object(:get, "v1/partners/me", {}, Uber::Partner::Partner, self.client)
+      end
+
+      def payments(*args)
+        arguments = Uber::Arguments.new(args)
+        perform_with_object(:get, "/v1/partners/payments", arguments.options, Uber::Partner::PaymentActivity, self.client)
+      end
+
+      def trips(*args)
+        arguments = Uber::Arguments.new(args)
+        perform_with_object(:get, "/v1/partners/trips", arguments.options, Uber::Partner::TripActivity, self.client)
+      end
+
+      alias_method :earnings, :payments
+    end
+  end
+end

data/lib/uber/client.rb

@@ -117,6 +117,9 @@ module Uber
       credentials.values.all?
     end
 
+    def partners
+      @partners ||= Uber::Partner::Client.new self
+    end
     private
 
     # Ensures that all credentials set during configuration are
@@ -167,4 +170,15 @@ module Uber
       "Token #{@server_token}"
     end
   end
+
+  module Partner
+    class Client
+      include Uber::API::Partners
+      attr_reader :client
+      def initialize(client)
+        @client = client
+      end
+    end
+  end
+
 end

data/lib/uber/models/partner.rb

@@ -0,0 +1,3 @@
+require 'uber/models/partner/partner'
+require 'uber/models/partner/payment'
+require 'uber/models/partner/trip'

data/lib/uber/models/partner/partner.rb

@@ -0,0 +1,8 @@
+module Uber
+  module Partner
+    class Partner < Base
+      attr_accessor :driver_id, :first_name, :last_name, :phone_number, :email, :picture,
+                    :rating, :promo_code, :activation_status
+    end
+  end
+end

data/lib/uber/models/partner/payment.rb

@@ -0,0 +1,23 @@
+module Uber
+  module Partner
+
+    class PaymentActivity < Base
+      attr_accessor :offset, :limit, :count, :payments
+
+      def payments=(values)
+        @payments = values.map { |value| Uber::Partner::Payment.new value }
+      end
+    end
+
+    class Payment < Base
+      attr_accessor :category, :breakdown, :rider_fees, :event_time, :trip_id, :cash_collected,
+                    :amount, :driver_id, :partner_id, :currency_code
+
+      def event_time
+        ::Time.at @event_time
+      end
+    end
+
+  end
+
+end

data/lib/uber/models/partner/trip.rb

@@ -0,0 +1,29 @@
+module Uber
+  module Partner
+
+    class TripActivity < Base
+      attr_accessor :count, :limit, :offset, :trips
+
+      def trips=(values)
+        @trips = values.map { |value| Uber::Partner::Trip.new value }
+      end
+    end
+
+    class Trip < Base
+      attr_accessor :dropoff, :vehicle_id, :distance, :start_city, :status_changes, :pickup,
+                    :driver_id, :status, :duration, :trip_id
+
+      def status_changes=(values)
+        @status_changes = values.map { |value| Uber::Partner::StatusChange.new value }
+      end
+    end
+
+    class StatusChange < Base
+      attr_accessor :status, :timestamp
+
+      def time
+        ::Time.at @timestamp if @timestamp
+      end
+    end
+  end
+end

data/lib/uber/utils.rb

@@ -7,8 +7,8 @@ module Uber
     # @param path [String]
     # @param options [Hash]
     # @param klass [Class]
-    def perform_with_object(request_method, path, options, klass)
-      request = Uber::ApiRequest.new(self, request_method, path, options)
+    def perform_with_object(request_method, path, options, klass, client=self)
+      request = Uber::ApiRequest.new(client, request_method, path, options)
       request.perform_with_object(klass)
     end
 
@@ -16,8 +16,8 @@ module Uber
     # @param path [String]
     # @param options [Hash]
     # @param klass [Class]
-    def perform_with_objects(request_method, path, options, klass)
-      request = Uber::ApiRequest.new(self, request_method, path, options)
+    def perform_with_objects(request_method, path, options, klass, client=self)
+      request = Uber::ApiRequest.new(client, request_method, path, options)
       request.perform_with_objects(klass)
     end
   end

data/lib/uber/version.rb

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

metadata

@@ -1,97 +1,97 @@
 --- !ruby/object:Gem::Specification
 name: uber-ruby
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Dingding Ye
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-13 00:00:00.000000000 Z
+date: 2017-02-12 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'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.8'
 description: A Ruby interface to the Uber API.
@@ -108,6 +108,7 @@ files:
 - lib/uber/api.rb
 - lib/uber/api/activities.rb
 - lib/uber/api/me.rb
+- lib/uber/api/partners.rb
 - lib/uber/api/places.rb
 - lib/uber/api/price_estimates.rb
 - lib/uber/api/products.rb
@@ -123,6 +124,10 @@ files:
 - lib/uber/models/activity.rb
 - lib/uber/models/estimate.rb
 - lib/uber/models/map.rb
+- lib/uber/models/partner.rb
+- lib/uber/models/partner/partner.rb
+- lib/uber/models/partner/payment.rb
+- lib/uber/models/partner/trip.rb
 - lib/uber/models/place.rb
 - lib/uber/models/price.rb
 - lib/uber/models/product.rb
@@ -147,17 +152,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.2
+rubygems_version: 2.4.5.2
 signing_key: 
 specification_version: 4
 summary: The Uber Ruby Gem.