rallio 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8b601ef0809d471e7bf37312a8a67ed74556ea94
-  data.tar.gz: 582c8fedf7245d6e3f598a22bdcd37fc66be48fe
+  metadata.gz: 5c4ea3d06f8622e3412ca3a95e0f1a68cb02ae40
+  data.tar.gz: 972a7189aa36fa4840d3cf84b00d085509bba86c
 SHA512:
-  metadata.gz: 2544c8ab2c57dec681956f97d5f845c030f474725e6d0acd55f41b0c12403e015a37efd482ac94223e1eb5984f43e6a533be605dbb36f1c477627f51a9e3949c
-  data.tar.gz: b416734a6a656be1cd74c64d725a159d75fa19f428dd9d48ab20e196deb59757518b82910638262ce5ee30f3bdf222028d4765ca56b76bd1bfdc3f9d1713d8ea
+  metadata.gz: 62b63506746d5e6f923cd628afe9c1697cf25fbf3cfb9734d1a9392297010c38edd28ec5d9265f9d4f13f84c3fedf70e9913cd209309d528969d58a43fbc664c
+  data.tar.gz: d8226ce802c1209a0e0c78edf08ef2f7e96f3ce3e7d797e5c949e6971979630c49c5b6c905edddd4046f90d91d1d3e3e84dc80a6e746e4cd68944517157678d5

data/README.md

@@ -93,6 +93,24 @@ user.access_token
 # => <Rallio::AccessToken @access_token="4a25dd89e50bd0a0db1eeae65864fe6b", @user_id=100, @expires_at=nil, @scopes="user_info basic_access">
 ```
 
+#### #account_ownerships
+
+Returns all the accounts this user is associated with.
+
+```ruby
+user.account_ownerships
+# => [#<Rallio::AccountOwnership:0x007fc3aaaa70b0 @user_id=100, @account_id=200, @account_name="Awesome Haircuts New York City", @account_franchisor_id=300, @account_franchisor_name="Awesome Haircuts Franchisor 1">]
+```
+
+#### #franchisor_ownerships
+
+Returns all the franchisors this user is associated with.
+
+```ruby
+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.
@@ -147,6 +165,87 @@ access_token = Rallio::AccessToken.new(access_token: '4a25dd89e50bd0a0db1eeae658
 access_token.destroy                              # => true
 ```
 
+### FranchisorOwnership
+
+#### .for
+
+Returns all franchisors for a given access token.
+
+```ruby
+Rallio::FranchisorOwnership.for(access_token: '4a25dd89e50bd0a0db1eeae65864fe6b')
+# => [<Rallio::FranchisorOwnership:0x007f93d8986340 @user_id=100, @franchisor_id=300, @franchisor_name="Awesome Haircuts Franchisor 1">]
+```
+
+#### .create
+
+This creates an association between a user and a Franchisor.
+
+```ruby
+Rallio::FranchisorOwnership.create(user_id: 100, franchisor_id: 300)
+# => <Rallio::FranchisorOwnership:0x007f93d8986340 @user_id=100, @franchisor_id=300, @franchisor_name="Awesome Haircuts Franchisor 1">
+```
+
+#### .destroy
+
+Destroys a relationship between user and franchisor.
+
+```ruby
+Rallio::FranchisorOwnership.destroy(user_id: 100, franchisor_id: 300)
+# => {}
+```
+
+### AccountOwnership
+
+#### .for
+
+Returns all accounts for a given access token.
+
+```ruby
+Rallio::AccountOwnership.for(access_token: '4a25dd89e50bd0a0db1eeae65864fe6b')
+# => [<Rallio::AccountOwnership:0x007fc3aaaa70b0 @user_id=100, @account_id=200, @account_name="Awesome Haircuts New York City", @account_franchisor_id=300, @account_franchisor_name="Awesome Haircuts Franchisor 1">]
+```
+
+#### .create
+
+This creates an association between a user and an Account.
+
+```ruby
+Rallio::AccountOwnership.create(user_id: 100, account_id: 200)
+# => <Rallio::AccountOwnership:0x007fc3aaaa70b0 @user_id=100, @account_id=200, @account_name="Awesome Haircuts New York City", @account_franchisor_id=300, @account_franchisor_name="Awesome Haircuts Franchisor 1">
+```
+
+#### .destroy
+
+Destroys a relationship between user and account.
+
+```ruby
+Rallio::AccountOwnership.destroy(user_id: 100, account_id: 200)
+# => {}
+```
+
+### Franchisor
+
+#### .all
+
+Returns all franchisors for a given set of app credentials.
+
+```ruby
+Rallio::Franchisor.all
+# => [<Rallio::Franchisor:0x007fa944c30e48 @id=100, @name="Awesome Haircuts", @short_name=nil, @url=nil, @city=nil, @country_code=nil, @time_zone=nil>]
+```
+
+#### #accounts
+
+Returns all accounts associated with a franchisor.
+
+```ruby
+franchisor = Rallio::Franchisor.new(id: 100)
+# => <Rallio::Franchisor:0x007fa944c30e48 @id=100, @name=nil, @short_name=nil, @url=nil, @city=nil, @country_code=nil, @time_zone=nil>
+
+franchisor.accounts
+# => [<Rallio::Account:0x007f801bb0a610 @id=100, @name="Awesome Haircuts New York City", @short_name="AH-NYC", @url="https://awesomehaircuts.fake", @city="New York", @country_code="US", @time_zone="Eastern Time (US & Canada)">]
+```
+
 ### Account
 
 These gives access to account info that a user has access to. In order to query
@@ -157,7 +256,16 @@ user.access_token
 # => <Rallio::AccessToken @access_token="4a25dd89e50bd0a0db1eeae65864fe6b", @user_id=100, @expires_at=nil, @scopes="user_info basic_access">
 ```
 
-#### .reviews
+#### .for
+
+Get all accounts for a given franchisor_id.
+
+```ruby
+accounts = Rallio::Account.for(franchisor_id: 200)
+# => [<Rallio::Account:0x007f801bb0a610 @id=100, @name="Awesome Haircuts New York City", @short_name="AH-NYC", @url="https://awesomehaircuts.fake", @city="New York", @country_code="US", @time_zone="Eastern Time (US & Canada)">]
+```
+
+#### #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

data/lib/rallio/account.rb

@@ -12,6 +12,11 @@ module Rallio
       Review.all(type: type, id: id, access_token: access_token)
     end
 
+    def self.for(franchisor_id:)
+      response = self.get("/franchisors/#{franchisor_id}/accounts", headers: app_credentials)
+      response.parsed_response['accounts'].map { |a| new a }
+    end
+
     private
 
     def type

data/lib/rallio/account_ownership.rb

@@ -0,0 +1,17 @@
+module Rallio
+  class AccountOwnership < OwnershipsBase
+    attribute :user_id, Integer
+    attribute :account_id, Integer
+    attribute :account_name, String
+    attribute :account_franchisor_id, Integer
+    attribute :account_franchisor_name, String
+
+    def self.url_segment
+      'account_ownerships'
+    end
+
+    def self.response_key
+      'account_ownership'
+    end
+  end
+end

data/lib/rallio/base.rb

@@ -11,11 +11,5 @@ 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

@@ -6,8 +6,7 @@ module Rallio
     end
 
     def accounts
-      response = self.class.get("/franchisors/#{id}/accounts", headers: app_credentials)
-      response.parsed_response['accounts'].map { |a| Rallio::Account.new(a) }
+      Rallio::Account.for(franchisor_id: id)
     end
 
     private

data/lib/rallio/franchisor_ownership.rb

@@ -0,0 +1,15 @@
+module Rallio
+  class FranchisorOwnership < OwnershipsBase
+    attribute :user_id, Integer
+    attribute :franchisor_id, Integer
+    attribute :franchisor_name, String
+
+    def self.url_segment
+      'franchisor_ownerships'
+    end
+
+    def self.response_key
+      'franchisor_ownership'
+    end
+  end
+end

data/lib/rallio/ownerships_base.rb

@@ -0,0 +1,18 @@
+module Rallio
+  class OwnershipsBase < Base
+    def self.for(access_token:)
+      headers = { 'Authorization' => "Bearer #{access_token}" }
+      response = self.get("/#{url_segment}", headers: headers)
+      response.parsed_response["#{url_segment}"].map { |a| new(a) }
+    end
+
+    def self.create(user_id:, payload:)
+      response = self.post("/users/#{user_id}/#{url_segment}", headers: app_credentials, body: payload)
+      new response.parsed_response["#{response_key}"]
+    end
+
+    def self.destroy(user_id:, object_id:)
+      self.delete("/users/#{user_id}/#{url_segment}/#{object_id}", headers: app_credentials)
+    end
+  end
+end

data/lib/rallio/user.rb

@@ -28,13 +28,11 @@ module Rallio
     end
 
     def account_ownerships
-      response = self.class.get('/account_ownerships', headers: user_credentials)
-      response.parsed_response
+      AccountOwnership.for(access_token: access_token.access_token)
     end
 
     def franchisor_ownerships
-      response = self.class.get('/franchisor_ownerships', headers: user_credentials)
-      response.parsed_response
+      FranchisorOwnership.for(access_token: access_token.access_token)
     end
 
     # Initially this endpoint was in the API docs but it appears it may not be
@@ -45,11 +43,5 @@ module Rallio
     #   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.2"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rallio
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - JD Guzman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-10 00:00:00.000000000 Z
+date: 2017-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: virtus
@@ -142,8 +142,11 @@ files:
 - lib/rallio.rb
 - lib/rallio/access_token.rb
 - lib/rallio/account.rb
+- lib/rallio/account_ownership.rb
 - lib/rallio/base.rb
 - lib/rallio/franchisor.rb
+- lib/rallio/franchisor_ownership.rb
+- lib/rallio/ownerships_base.rb
 - lib/rallio/review.rb
 - lib/rallio/sign_on_token.rb
 - lib/rallio/user.rb