oneaccess 0.1.8 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c33c036b76dd4e04030e1fbddeab3e1712b3310d
-  data.tar.gz: 3536eb9fd5be517e69b1babc00e9a5242ec34f84
+  metadata.gz: 9345968033df9754320ae59b779ee0a12fa1da66
+  data.tar.gz: 87cd0f91f5de14cf0c3774fa514187a1f3fd0c25
 SHA512:
-  metadata.gz: 5db803a6ca78402d935b9916fb4ab8996bc7e1e7507cf5f768978155b1e51fff84356f7a775749766d70475c18d668414f66679d44822763a3a0a3f628e8d09e
-  data.tar.gz: de218538bf247fe54e6beea9aeee31b3479b18dfc3729f58a7a9c828c93f395a2ecfe8df446c69692bac14a6e850ecafaeae7ca4549afbe9c27351443896462c
+  metadata.gz: 6164fd7a024bd81e6963bd82b9e9808c0cc67a38098cea3e6f45c4f175a4c511b742e274f6bf6524fd1d37eac1a3179f957b05b79df3b0c7f9326c663bd15a41
+  data.tar.gz: a4b9c4f1a6c9a336eb03c2d832f0aefb8974fe2352d1ce1511bf4d7e66cd6bfe410b466438aac8d0f8bf5713aaee686a97f36ba788edaf7f6323743ee77a9684

data/README.md

@@ -41,6 +41,8 @@ Not all the methods in the API are currently supported, here's a list of all sup
 - Organization: _/organizations/id_
 - User's Product Groups: _/entitlement/user/productgroup/getList_
 - User Entitlement Requests: _/entitlement/research/userRequests/getListWithEntitlementsStatus_
+- Subscribe to Entitlements Updates: _/entitlement/userSubscription/subscribeToUpdates_
+- Get User ids which entitlements have changed _/entitlement/userSubscription/subscribeToUpdates/changedUsers/getList_
 
 ### User by Email _(/user/getByEmail)_
 Official Documentation: http://apidocs.oneaccess.io/docs/usergetorcreate
@@ -189,3 +191,42 @@ rescue ONEAccess::Error::APIError => e
   puts "Error listing the available user entitlement requests"
 end
 ```
+
+### Subscribe to Entitlements Updates _(/entitlement/userSubscription/subscribeToUpdates)_
+Official Documentation: http://apidocs.oneaccess.io/docs/entitlmentusersubscriptionsubscribetoupdates
+
+This method allows to subscribe for user entitlement updates providing the list of users that one wishes
+to receive updates from. Returns the API Status Code as the result of the subscription operation.
+
+#### How to use:
+```ruby
+begin
+  resp = ONEAccess::API::Entitlement::UserSubscription.subscribe(user_ids: [<user_ids>])
+
+  resp #=> instance of ONEAcess::Response::SubscribeToUpdatesResponse
+rescue ONEAccess::Error::APIError => e
+  puts "Error subscribing users for entitlements updates"
+end
+```
+
+### Get User ids which entitlements have changed _(/entitlement/userSubscription/subscribeToUpdates/changedUsers/getList)_
+Official Documentation: http://apidocs.oneaccess.io/docs/entitlementusersubscriptionsubscribetoupdateschangedusersgetlist
+
+This method allows to get the list of user ids which the entitlements have changed.
+Can be provided a date to get the users who have changed entitlements after the provided date. If the date is not provided then it returns the user ids in which the entitlements have changed after the last call to this method. For example:
+
+First call at 08/22/2016 11:55:00.
+Next call at 08/22/2016 15:55:00. Returns the user ids who have changed entitlements after 08/22/2016 11:55:00.
+
+Use UTC time zone for date parameter.
+
+#### How to use:
+```ruby
+begin
+  resp = ONEAccess::API::Entitlement::UserSubscription.changed_users(from_date: <utc_string_date>)
+
+  resp #=> instance of ONEAcess::Response::ChangedUsersResponse
+rescue ONEAccess::Error::APIError => e
+  puts "Error getting the list of user ids which entitlements have changed"
+end
+```

data/lib/oneaccess.rb

@@ -16,6 +16,7 @@ require_relative "./oneaccess/api/research"
 require_relative "./oneaccess/api/organizations"
 require_relative "./oneaccess/api/symbology"
 require_relative "./oneaccess/api/references"
+require_relative "./oneaccess/api/entitlement/user_subscription"
 require_relative "./oneaccess/api/entitlement/organization/product_group"
 require_relative "./oneaccess/api/entitlement/user/product_group"
 require_relative "./oneaccess/api/entitlement/research/user_requests"

data/lib/oneaccess/api/entitlement/user_subscription.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative "../../response/subscribe_to_updates_response"
+require_relative "../../response/changed_users_response"
+
+module ONEAccess
+  module API
+    module Entitlement
+      class UserSubscription < Base
+        api_path "/entitlement/userSubscription"
+
+        def self.subscribe(user_ids:)
+          response = send_post("subscribeToUpdates", user_ids)
+
+          Response::SubscribeToUpdatesResponse.from_json(response.body)
+        end
+
+        def self.changed_users(from_date: nil)
+          params = { dateFrom: from_date }.reject { |_, v| v.nil? }
+          response = send_get("subscribeToUpdates/changedUsers/getList", params)
+
+          Response::ChangedUsersResponse.from_json(response.body)
+        end
+      end
+    end
+  end
+end

data/lib/oneaccess/response/changed_users_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative "./base_response"
+require_relative "./representer/changed_users_response"
+
+module ONEAccess
+  module Response
+    class ChangedUsersResponse < BaseResponse
+      represented_by Representer::ChangedUsersResponse
+    end
+  end
+end

data/lib/oneaccess/response/representer/changed_users_response.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative "./base_response"
+
+module ONEAccess
+  module Response
+    module Representer
+      class ChangedUsersResponse < BaseResponse
+        property :data, as: :Data
+      end
+    end
+  end
+end

data/lib/oneaccess/response/representer/subscribe_to_updates_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative "./base_response"
+
+module ONEAccess
+  module Response
+    module Representer
+      class SubscribeToUpdatesResponse < BaseResponse
+      end
+    end
+  end
+end

data/lib/oneaccess/response/subscribe_to_updates_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative "./base_response"
+require_relative "./representer/subscribe_to_updates_response"
+
+module ONEAccess
+  module Response
+    class SubscribeToUpdatesResponse < BaseResponse
+      represented_by Representer::SubscribeToUpdatesResponse
+    end
+  end
+end

data/oneaccess.gemspec

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 Gem::Specification.new do |s|
   s.name          = "oneaccess"
-  s.version       = "0.1.8"
-  s.date          = "2018-01-10"
+  s.version       = "0.1.9"
+  s.date          = "2018-01-29"
   s.summary       = "ONEAccess API wrapper"
   s.description   = "Easily communicate with ONEAccess API"
   s.homepage      = "https://github.com/AlphaExchange/rixml"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oneaccess
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.9
 platform: ruby
 authors:
 - Alex Correia Santos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-10 00:00:00.000000000 Z
+date: 2018-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -190,6 +190,7 @@ files:
 - lib/oneaccess/api/entitlement/organization/product_group.rb
 - lib/oneaccess/api/entitlement/research/user_requests.rb
 - lib/oneaccess/api/entitlement/user/product_group.rb
+- lib/oneaccess/api/entitlement/user_subscription.rb
 - lib/oneaccess/api/organizations.rb
 - lib/oneaccess/api/references.rb
 - lib/oneaccess/api/research.rb
@@ -237,6 +238,7 @@ files:
 - lib/oneaccess/error/api_error.rb
 - lib/oneaccess/response/api_error.rb
 - lib/oneaccess/response/base_response.rb
+- lib/oneaccess/response/changed_users_response.rb
 - lib/oneaccess/response/companies_response.rb
 - lib/oneaccess/response/company_response.rb
 - lib/oneaccess/response/countries_response.rb
@@ -246,6 +248,7 @@ files:
 - lib/oneaccess/response/product_groups_response.rb
 - lib/oneaccess/response/representer/api_error.rb
 - lib/oneaccess/response/representer/base_response.rb
+- lib/oneaccess/response/representer/changed_users_response.rb
 - lib/oneaccess/response/representer/companies_response.rb
 - lib/oneaccess/response/representer/company_response.rb
 - lib/oneaccess/response/representer/countries_response.rb
@@ -254,10 +257,12 @@ files:
 - lib/oneaccess/response/representer/paginated_response.rb
 - lib/oneaccess/response/representer/product_groups_response.rb
 - lib/oneaccess/response/representer/research_document_response.rb
+- lib/oneaccess/response/representer/subscribe_to_updates_response.rb
 - lib/oneaccess/response/representer/user_entitlement_requests_response.rb
 - lib/oneaccess/response/representer/user_requests_response.rb
 - lib/oneaccess/response/representer/user_response.rb
 - lib/oneaccess/response/research_document_response.rb
+- lib/oneaccess/response/subscribe_to_updates_response.rb
 - lib/oneaccess/response/user_entitlement_requests_response.rb
 - lib/oneaccess/response/user_requests_response.rb
 - lib/oneaccess/response/user_response.rb