rallio 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 729f2d4f0b9082fa4c434fa5c330a6784c23bbd8
-  data.tar.gz: f3ba57fc036f2d9a171cb0fe8d2c38905e0e48eb
+  metadata.gz: 8b601ef0809d471e7bf37312a8a67ed74556ea94
+  data.tar.gz: 582c8fedf7245d6e3f598a22bdcd37fc66be48fe
 SHA512:
-  metadata.gz: b614a404effdec5976423126b7ba597e6a95c35b69f24934f54ee16d95f867cd421f699cbea9ecf1069646b3a6ee3823d451aa22d0d4255bc8c3da52702595c2
-  data.tar.gz: ae6659df5d599925db6d9b01a6580d4cc0e0d9953fa4dd273e4253504898aa8ff59f73fef1d1a3625e8d9d89fe82c659f577f60f95a91c5291b32d50008a40ec
+  metadata.gz: 2544c8ab2c57dec681956f97d5f845c030f474725e6d0acd55f41b0c12403e015a37efd482ac94223e1eb5984f43e6a533be605dbb36f1c477627f51a9e3949c
+  data.tar.gz: b416734a6a656be1cd74c64d725a159d75fa19f428dd9d48ab20e196deb59757518b82910638262ce5ee30f3bdf222028d4765ca56b76bd1bfdc3f9d1713d8ea

data/README.md

@@ -54,23 +54,36 @@ Rallio::User.accessible_users
 # [<Rallio::User:0x007fc325b36808 @id=100, @email="bob@yourcompany.com", @first_name="Bob", @last_name="Anderson", @accounts=[], @franchisors=[]>]
 ```
 
-#### #sign_on_tokens
+#### .create
+
+Creates a new user on the Rallio platform.
+
+```ruby
+# To create a user a hash with email, first_name and last_name keys must be
+# supplied.
+Rallio::User.create(user: { email: 'me@example.com', first_name: 'John', last_name: 'Doe' })
+# => { user: { id: 100, first_name: 'John', last_name: 'Doe', email: 'me@example.com' } }
+```
+
+#### #sign_on_token
 
 With an instantiated user object you can call to get a single sign-on token
-for the given user.
+for the given user. These tokens last for 5 minutes and allow the user to be
+signed into the Rallio platform by visiting the given url.
 
 ```ruby
 user
 # => <Rallio::User @id=100, @email="bob@yourcompany.com", @first_name="Bob", @last_name="Anderson", @accounts=[], @franchisors=[]>
 
-user.sign_on_tokens
+user.sign_on_token
 # => <Rallio::SignOnToken @token="15ad86b2ede6", @expires_at=#<DateTime: 2015-04-16T23:5...,321000000n),+0s,2299161j)>, @url="https://app.rallio.com/api/internal/sign_on_tokens/15ad86b2ede6">
 ```
 
 #### #access_token
 
 With an instantiated user object you can call to get an access token for the
-given user.
+given user. These access tokens do not expire at the moment so it is recommended
+that you store this and reuse the token.
 
 ```ruby
 user
@@ -82,6 +95,9 @@ user.access_token
 
 #### #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.
+
 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
 of the information.
@@ -131,6 +147,59 @@ access_token = Rallio::AccessToken.new(access_token: '4a25dd89e50bd0a0db1eeae658
 access_token.destroy                              # => true
 ```
 
+### Account
+
+These gives access to account info that a user has access to. In order to query
+the API using this class you will first need a user access token.
+
+```ruby
+user.access_token
+# => <Rallio::AccessToken @access_token="4a25dd89e50bd0a0db1eeae65864fe6b", @user_id=100, @expires_at=nil, @scopes="user_info basic_access">
+```
+
+#### .reviews
+
+This is a convenience method to get reviews for a given account. All that is
+needed is a `Rallio::Account` object instantiated with a valid account id. This
+calls the `Rallio::Review.all` method to get reviews.
+
+```ruby
+account = Rallio::Account.new(id: 9397)
+# => <Rallio::Account:0x007ff4d8160f60 @id=9397, @name=nil>
+
+account.reviews(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>]
+```
+
+### Review
+
+#### .all
+
+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
+# access_token: is the access token for a Rallio::User
+reviews = Rallio::Review.all(type: :accounts, id: 9397, 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>]
+```
+
+#### #reply
+
+To reply to a review you need a Review object with and id and access_token
+passed in. Then you can just call the `Rallio::Review#reply` method with the
+text of your reply. **NOTE:** if you are using a review object obtained from a
+call to `Rallio::Review.all` the access_token is populated for you.
+
+```ruby
+review = Rallio::Review.new(access_token: '4a25dd89e50bd0a0db1eeae65864fe6b', id: 227704)
+# =><Rallio::Review:0x007fcf402de8f0 @access_token="4a25dd89e50bd0a0db1eeae65864fe6b", @id=227704, @account_id=nil, @account_name=nil, @network=nil, @posted_at=nil, @user_name=nil, @user_image=nil, @rating=nil, @message=nil, @comments=[], @liked=nil, @url=nil, @can_reply=nil, @location_name=nil, @location_image_url=nil, @review_reply=nil, @review_reply_at=nil>
+
+review.reply("This is my reply")
+# => {}
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/rallio/access_token.rb

@@ -6,12 +6,12 @@ module Rallio
     attribute :scopes, String
 
     def self.create(user_id:)
-      response = self.post("/users/#{user_id}/access_token", headers: app_credentials)
+      response = self.post("/users/#{user_id}/access_tokens", headers: app_credentials)
       new response.parsed_response
     end
 
     def destroy
-      headers = { 'Authentication' => "Bearer #{access_token}" }
+      headers = { 'Authorization' => "Bearer #{access_token}" }
       self.class.delete('/access_token', headers: headers)
       true
     end

data/lib/rallio/account.rb

@@ -1,4 +1,21 @@
 module Rallio
-  class Account < Franchisor
+  class Account < Base
+    attribute :id, Integer
+    attribute :name, String
+    attribute :short_name, String
+    attribute :url, String
+    attribute :city, String
+    attribute :country_code, String
+    attribute :time_zone, String
+
+    def reviews(access_token:)
+      Review.all(type: type, id: id, access_token: access_token)
+    end
+
+    private
+
+    def type
+      :accounts
+    end
   end
 end

data/lib/rallio/base.rb

@@ -11,5 +11,11 @@ module Rallio
         'X-Application-Secret' => Rallio.application_secret
       }
     end
+
+    private
+
+    def app_credentials
+      self.class.app_credentials
+    end
   end
 end

data/lib/rallio/franchisor.rb

@@ -1,8 +1,19 @@
 module Rallio
-  class Franchisor
-    include Virtus.model
+  class Franchisor < Account
+    def self.all
+      response = self.get('/franchisors', headers: app_credentials)
+      response.parsed_response['franchisors'].map { |f| new(f) }
+    end
 
-    attribute :id, Integer
-    attribute :name, String
+    def accounts
+      response = self.class.get("/franchisors/#{id}/accounts", headers: app_credentials)
+      response.parsed_response['accounts'].map { |a| Rallio::Account.new(a) }
+    end
+
+    private
+
+    def type
+      :franchisors
+    end
   end
 end

data/lib/rallio/review.rb

@@ -0,0 +1,32 @@
+module Rallio
+  class Review < Base
+    attribute :id, Integer
+    attribute :account_id, Integer
+    attribute :account_name, String
+    attribute :network, String
+    attribute :posted_at, DateTime
+    attribute :user_name, String
+    attribute :user_image, String
+    attribute :rating, Float
+    attribute :message, String
+    attribute :comments, Array[Hash]
+    attribute :liked, Axiom::Types::Boolean
+    attribute :url, String
+    attribute :can_reply, Axiom::Types::Boolean
+    attribute :location_name, String
+    attribute :location_image_url, String
+    attribute :review_reply, String
+    attribute :review_reply_at, DateTime
+
+    def self.all(type:, id:, access_token:)
+      headers = { 'Authorization' => "Bearer #{access_token}" }
+      response = self.get("/#{type}/#{id}/reviews", headers: headers)
+      response.parsed_response['reviews'].map { |r| new(r) }
+    end
+
+    def reply(message:, access_token:)
+      headers = { 'Authorization' => "Bearer #{access_token}" }
+      self.class.post("/reviews/#{id}/reply", headers: headers, body: { message: message })
+    end
+  end
+end

data/lib/rallio/sign_on_token.rb

@@ -6,7 +6,7 @@ module Rallio
 
     def self.create(user_id:)
       response = self.post("/users/#{user_id}/sign_on_tokens", headers: app_credentials)
-      new response.parsed_response
+      new response.parsed_response['sign_on_token']
     end
   end
 end

data/lib/rallio/user.rb

@@ -7,12 +7,19 @@ module Rallio
     attribute :accounts, Array[Account]
     attribute :franchisors, Array[Franchisor]
 
+    attr_writer :access_token
+
     def self.accessible_users
       response = self.get('/accessible_users', headers: app_credentials)
-      response.parsed_response[:users].map { |u| User.new(u) }
+      response.parsed_response['users'].map { |u| User.new(u) }
+    end
+
+    def self.create(user:)
+      response = self.post('/users', headers: app_credentials, body: { user: user })
+      new response.parsed_response['user']
     end
 
-    def sign_on_tokens
+    def sign_on_token
       SignOnToken.create(user_id: id)
     end
 
@@ -20,11 +27,29 @@ module Rallio
       @access_token ||= AccessToken.create(user_id: id)
     end
 
-    def me
-      headers = { 'Authentication' => "Bearer #{access_token.access_token}" }
-      response = self.class.get('/users/me', headers: headers)
-      self.attributes = response.parsed_response
-      self
+    def account_ownerships
+      response = self.class.get('/account_ownerships', headers: user_credentials)
+      response.parsed_response
+    end
+
+    def franchisor_ownerships
+      response = self.class.get('/franchisor_ownerships', headers: user_credentials)
+      response.parsed_response
+    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.
+    #
+    # def me
+    #   response = self.class.get('/users/me', 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.2.1"
+  VERSION = "0.2.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rallio
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - JD Guzman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-07 00:00:00.000000000 Z
+date: 2017-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: virtus
@@ -144,6 +144,7 @@ files:
 - lib/rallio/account.rb
 - lib/rallio/base.rb
 - lib/rallio/franchisor.rb
+- lib/rallio/review.rb
 - lib/rallio/sign_on_token.rb
 - lib/rallio/user.rb
 - lib/rallio/version.rb