rallio 0.4.2 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1e09140384dd4ab0295ebfd128a49328538a8e37
-  data.tar.gz: a01df9d158fd7a6985f63fb7bd8b3b1506f31edb
+  metadata.gz: a52fdea6f8d7d74e99bc1c1c0cf9304bbe93aa55
+  data.tar.gz: dccc50810f98dc4c42cd2c146ae3c2239ff2af91
 SHA512:
-  metadata.gz: 295ca0a315f2adf7c0c88c8e5f16e4ba24bc01657d9ae53646735e80010baa6583f54823ecc205af7d109a777b338cc5b625ae0e6ca6013251f1cbc86f8a19b7
-  data.tar.gz: c191d0f8bf882bf02f5d3fec612750d567d7cb486bd7f88603936b5453c2b141529e991c90a1bcff376d25508f9f7b7e21de533c859334dec46006ab1c7ce518
+  metadata.gz: 678dbebaac83cbc1bb1721d49fdfcb1b219e231660c11c1d36e498aba4bc58b9b1a2ea326fdd9333282a93cc14b70cac63673bd100cbcb4daa16cb905f0a9ff1
+  data.tar.gz: c7cbc8781cfd506b8492ed07b901d70e4f1c32823a4201c891058b0aaea9d5e6aa8b2b6aa58c3d6cbae0dc4296d79fa24553e0c996ddf77a86301f55bee0a551

data/lib/rallio/access_token.rb

@@ -2,12 +2,13 @@ module Rallio
   # Represents an access token object as it comes from Rallio.
   #
   # @!attribute [rw] access_token
-  #   Access token string
+  #   @return [String] actual access token string
   # @!attribute [rw] user_id
+  #   @return [Integer] unique id for user
   # @!attribute [rw] expires_at
   #   @return [DateTime, nil] expiration DateTime or nil if access token never expires
   # @!attribute [rw] scopes
-  #   List of oauth scopes for the access token
+  #   @return [String] list of oauth scopes for the access token
   class AccessToken < Base
     attribute :access_token, String
     attribute :user_id, Integer

data/lib/rallio/account.rb

@@ -2,12 +2,19 @@ module Rallio
   # Represents an account object as it comes from Rallio.
   #
   # @!attribute [rw] id
+  #   @return [Integer] unique id for account
   # @!attribute [rw] name
+  #   @return [String] account name
   # @!attribute [rw] short_name
+  #   @return [String] account short name
   # @!attribute [rw] url
+  #   @return [String] account url
   # @!attribute [rw] city
+  #   @return [String] account city
   # @!attribute [rw] country_code
+  #   @return [String] account country code
   # @!attribute [rw] time_zone
+  #   @return [String] account time zone
   class Account < Base
     attribute :id, Integer
     attribute :name, String

data/lib/rallio/account_ownership.rb

@@ -2,10 +2,15 @@ module Rallio
   # Represents an account ownership object as it comes from Rallio.
   #
   # @!attribute [rw] user_id
+  #   @return [Integer] unique id for user
   # @!attribute [rw] account_id
+  #   @return [Integer] unique id for account
   # @!attribute [rw] account_name
+  #   @return [String] account name
   # @!attribute [rw] account_franchisor_id
+  #   @return [Integer] unique id for franchisor
   # @!attribute [rw] account_franchisor_name
+  #   @return [String] franchisor name
   class AccountOwnership < OwnershipsBase
     attribute :user_id, Integer
     attribute :account_id, Integer

data/lib/rallio/franchisor_ownership.rb

@@ -2,8 +2,11 @@ module Rallio
   # Represents a franchisor ownership as it comes from Rallio.
   #
   # @!attribute [rw] user_id
+  #   @return [Integer] unique id for user
   # @!attribute [rw] franchisor_id
+  #   @return [Integer] unique id for franchisor
   # @!attribute [rw] franchisor_name
+  #   @return [String] franchisor name
   class FranchisorOwnership < OwnershipsBase
     attribute :user_id, Integer
     attribute :franchisor_id, Integer

data/lib/rallio/review.rb

@@ -2,22 +2,39 @@ module Rallio
   # Represents a review object as it comes from Rallio.
   #
   # @!attribute [rw] id
+  #   @return [Integer] unique id for review
   # @!attribute [rw] account_id
+  #   @return [Integer] unique id for account
   # @!attribute [rw] account_name
+  #   @return [String] account name
   # @!attribute [rw] network
+  #   @return [String] social network review was posted to
   # @!attribute [rw] posted_at
+  #   @return [DateTime] DateTime review was made
   # @!attribute [rw] user_name
+  #   @return [String] social network username of reviewer
   # @!attribute [rw] user_image
+  #   @return [String] link to image of reviewer
   # @!attribute [rw] rating
+  #   @return [Integer] overall review rating
   # @!attribute [rw] message
+  #   @return [String] review text left by reviewer
   # @!attribute [rw] comments
+  #   @return [Array<Hash>] for facebook this is an array of responses to review
   # @!attribute [rw] liked
+  #   @return [true, false] true if review has been liked
   # @!attribute [rw] url
+  #   @return [String] url to review
   # @!attribute [rw] can_reply
+  #   @return [true, false] true if review can be replied to
   # @!attribute [rw] location_name
+  #   @return [String] location review is for
   # @!attribute [rw] location_image_url
+  #   @return [String] url for image of location
   # @!attribute [rw] review_reply
+  #   @return [String] reply for non-facebook reviews
   # @!attribute [rw] review_reply_at
+  #   @return [DateTime] DateTime of reply for non-facebook reviews
   class Review < Base
     attribute :id, Integer
     attribute :account_id, Integer

data/lib/rallio/sign_on_token.rb

@@ -2,10 +2,11 @@ module Rallio
   # Represents a sign on token object as it comes from Rallio.
   #
   # @!attribute [rw] token
+  #   @return [String] token for SSO url
   # @!attribute [rw] expires_at
-  #   DateTime token and url will become invalid.
+  #   @return [DateTime] DateTime token and url will become invalid.
   # @!attribute [rw] url
-  #   Url to redirect user to for SSO with token embedded
+  #   @return [String] url to redirect user to for SSO with token embedded
   class SignOnToken < Base
     attribute :token, String
     attribute :expires_at, DateTime

data/lib/rallio/user.rb

@@ -2,9 +2,13 @@ module Rallio
   # Represents a user object as it comes from Rallio.
   #
   # @!attribute [rw] id
+  #   @return [Integer] unique id for user
   # @!attribute [rw] email
+  #   @return [String] user email
   # @!attribute [rw] first_name
+  #   @return [String] user first name
   # @!attribute [rw] last_name
+  #   @return [String] user last name
   class User < Base
     attribute :id, Integer
     attribute :email, String

data/lib/rallio/version.rb

@@ -1,3 +1,3 @@
 module Rallio
-  VERSION = "0.4.2"
+  VERSION = "0.4.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rallio
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.3
 platform: ruby
 authors:
 - JD Guzman