rallio 0.4.5 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 173b2cc079841141428af0d262190965338cf565
-  data.tar.gz: eb80eed426664e0e41b7959fdf6052e31d80ca0a
+  metadata.gz: ade13b37179b9aae4933fb452929369d2d3ef1b0
+  data.tar.gz: d5465b01ab5f24df3070bf1c3b29fc3fafe66a7b
 SHA512:
-  metadata.gz: 9d0e892a1f8692f05565e994680e5e3024054ac1ef50422bce25243c5e322f6627d0d7b06229728c12c5560a5a6f71b29fd8ff5b70ce9fee8c2a3ad55b3fa5f4
-  data.tar.gz: 2ddced76f1d321a8863449803cda3ce4ee351b2562915d09c99d79f995fa94c141c1a78d625e6981e690f36fed91108854a80322e9adfc8ea692805d038b0a6c
+  metadata.gz: 85e9e0598dc5497503604455d420479c5a6ea90088672054d2ffc75a4d22515c0594fe5e1db8dde75ff54b483fa8da672a4bcd10fdf1c48a7ce6b6696cf71280
+  data.tar.gz: 97ff5215c8fcdad9de133810d4a359d9987eeb848d5ff5f841ace63fd29555e50462b97ecff899a81d28f5d0313e821f729f880d6a23f4bec395816fe1745385

data/README.md

@@ -111,10 +111,7 @@ user.franchisor_ownerships
 # => [#<Rallio::FranchisorOwnership:0x007f93d8986340 @user_id=100, @franchisor_id=300, @franchisor_name="Awesome Haircuts Franchisor 1">]
 ```
 
-#### #me
-
-**NOTE:** This endpoint is in the docs but it appears it may not be implemented.
-This will remain here until that is cleared up.
+#### #dashboard
 
 This calls out and gets the user info for a given id. All that is needed is to
 instantiate an instance with a valid user id an calling me will pull the rest
@@ -124,7 +121,7 @@ of the information.
 user = Rallio::User.new(id: 100)
 # => <Rallio::User @id=100, @email=nil, @first_name=nil, @last_name=nil, @accounts=[], @franchisors=[]>
 
-user.me
+user.dashboard
 # => <Rallio::User @id=100, @email="bob@yourcompany.com", @first_name="Bob", @last_name="Anderson", @accounts=[], @franchisors=[]>
 ```
 
@@ -301,10 +298,10 @@ account.reviews(access_token: user.access_token)
 This calls out to get all reviews for a given account or franchisor.
 
 ```ruby
-# type: can be either of :accounts or :franchisors
-# id: is the id for the account or franchisor
+# query_params: possible keys are: :page, :account_id, :franchisor_id, :network
+#                                  :start_date, :end_date, :rating
 # access_token: is the access token for a Rallio::User
-reviews = Rallio::Review.all(type: :accounts, id: 9397, access_token: user.access_token)
+reviews = Rallio::Review.all(query_params: {}, access_token: user.access_token)
 # => [<Rallio::Review:0x007fcf402de8f0 @access_token="4a25dd89e50bd0a0db1eeae65864fe6b", @id=227704, @account_id=9397, @account_name="Rally-O Tires New York", @network="facebook", @posted_at=#<DateTime: 2017-02-21T23:12:33+00:00 ((2457806j,83553s,0n),+0s,2299161j)>, @user_name="Andy Bobson", @user_image="https://graph.facebook.com/100009872044695/picture", @rating=5.0, @message="This is my favourite place to buy tires!", @comments=[{:user_name=>"Rally-O Tires New York", :user_image=>"https://graph.facebook.com/113397275345614/picture", :message=>"Thanks for the 5 star review!", :created_at=>"2017-02-22T00:49:53.000+00:00"}], @liked=true, @url="https://www.facebook.com/123123123", @can_reply=true, @location_name="Visiting Angels Newburyport MA", @location_image_url="https://scontent.xx.fbcdn.net/v/t1.0-1/p200x200/16266055_1428821143803214_8378119243787669723_n.jpg?oh=3268e6e30474a0aa488cfd896a6d6c06&oe=59357742", @review_reply=nil, @review_reply_at=nil>]
 ```
 

data/lib/rallio/review.rb

@@ -54,15 +54,25 @@ module Rallio
     attribute :review_reply, String
     attribute :review_reply_at, DateTime
 
-    # Retreives reviews.
+    # Retreives reviews. All query_params are optional. If no query_params are
+    # passed in all reviews accessible to user are returned.
     #
-    # @param type [String] one of accounts or franchisors to get reviews for
-    # @param id [Integer] account or franchisor id to get reviews for
+    # @param query_params [Hash] params to filter results
+    # @option query_params [String] :page results page
+    # @option query_params [String] :account_id filter results to one or more
+    #   accounts, should be seperated by commas
+    # @option query_params [String] :franchisor_id filter results to a single
+    #   franchisor
+    # @option query_params [String] :network filter results to one network,
+    #   possible choices are facebook, google_places, yelp
+    # @option query_params [String] :start_date iso8601 date to start on
+    # @option query_params [String] :end_date iso8601 date to end on
+    # @option query_params [String] :rating filter by rating
     # @param access_token [String] user access token to use for authorization
     # @return [Array<Rallio::Review>]
-    def self.all(type:, id:, access_token:)
+    def self.all(query_params: {}, access_token:)
       headers = { 'Authorization' => "Bearer #{access_token}" }
-      response = self.get("/#{type}/#{id}/reviews", headers: headers)
+      response = self.get("/reviews", query: query_params, headers: headers)
       response.parsed_response['reviews'].map { |r| new(r) }
     end
 

data/lib/rallio/user.rb

@@ -14,9 +14,8 @@ module Rallio
     attribute :email, String
     attribute :first_name, String
     attribute :last_name, String
-    # This may not be needed anymore, API still in flux
-    #attribute :accounts, Array[Account]
-    #attribute :franchisors, Array[Franchisor]
+    attribute :accounts, Array[Account]
+    attribute :franchisors, Array[Franchisor]
 
     attr_writer :access_token
 
@@ -75,13 +74,21 @@ module Rallio
       FranchisorOwnership.for(access_token: access_token.access_token)
     end
 
-    # Initially this endpoint was in the API docs but it appears it may not be
-    # implemented. This is here until that gets cleared up.
+    # Retreives current data for user.
     #
-    # def me
-    #   response = self.class.get('/users/me', headers: user_credentials)
-    #   self.attributes = response.parsed_response
-    #   self
-    # end
+    # @return [Rallio::User]
+    def dashboard
+      response = self.class.get('/dashboard', headers: user_credentials)
+      self.attributes = response.parsed_response
+      self
+    end
+
+    private
+
+    def user_credentials
+      {
+        'Authorization' => "Bearer #{access_token.access_token}"
+      }
+    end
   end
 end

data/lib/rallio/version.rb

@@ -1,3 +1,3 @@
 module Rallio
-  VERSION = "0.4.5"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rallio
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.5.0
 platform: ruby
 authors:
 - JD Guzman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-15 00:00:00.000000000 Z
+date: 2017-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: virtus