oneaccess 0.1.9 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9345968033df9754320ae59b779ee0a12fa1da66
-  data.tar.gz: 87cd0f91f5de14cf0c3774fa514187a1f3fd0c25
+  metadata.gz: 836845ecbb1939336288daf6be66a83ca10c80a1
+  data.tar.gz: 16607132135ce2ea5cde2abc5cf5b0ef19c15f26
 SHA512:
-  metadata.gz: 6164fd7a024bd81e6963bd82b9e9808c0cc67a38098cea3e6f45c4f175a4c511b742e274f6bf6524fd1d37eac1a3179f957b05b79df3b0c7f9326c663bd15a41
-  data.tar.gz: a4b9c4f1a6c9a336eb03c2d832f0aefb8974fe2352d1ce1511bf4d7e66cd6bfe410b466438aac8d0f8bf5713aaee686a97f36ba788edaf7f6323743ee77a9684
+  metadata.gz: 49d3e9169e15f060e8954cbcd5c031382fdf00c31dd1a965ed9219e9b4e4771c6a18f6b2441d538edfef593414f05586956df54394844c00c66935949508bdb6
+  data.tar.gz: 77555cb7e8a18d7db375b4b5d31b6eae4a23283360fb76e3da4c95b443a84bbf23dff11cb3b876803f7d7df896a34659360024ac1354cdd4b6eb7cc8d2e2cf1c

data/README.md

@@ -4,7 +4,7 @@ This is a ruby gem that wraps the ONEAccess API in an easy to use ruby library,
 The full documentation about the ONEAccess API can be found at:
 http://apidocs.oneaccess.io/docs
 
-Currently, only the version `v1.1` is supported by this gem.
+Currently, only the version `v1.1` and `v3.0` are supported by this gem.
 
 ## Installation & Setup
 Install the gem directly:
@@ -51,9 +51,9 @@ This method returns a `User` object if it matches the first name, last name, and
 
 #### How to use:
 ```ruby
-resp = ONEAccess::API::User.getByEmail(first_name: 'Alex', last_name: 'Santos', email: 'alex@ae.com')
+resp = ONEAccess::API::V1_1::User.getByEmail(first_name: 'Alex', last_name: 'Santos', email: 'alex@ae.com')
 
-resp.data #=> instance of ONEAcess::DataObject::User
+resp.data #=> instance of ONEAccess::DataObject::User
 resp.data.id #=> 305 (id of the user)
 resp.data.organization.id #=> 805 (id of the company)
 resp.data.email #=> alex@ae.com
@@ -67,9 +67,9 @@ This method retrieves a research document by providing the research ID and the f
 #### How to use:
 ```ruby
 begin
-  resp = ONEAccess::API::Research.document(document_id: 2341, first_name: 'Alex', last_name: 'Santos', email: 'alex@ae.com')
+  resp = ONEAccess::API::V1_1::Research.document(document_id: 2341, first_name: 'Alex', last_name: 'Santos', email: 'alex@ae.com')
 
-  resp.data #=> instance of ONEAcess::DataObject::ResearchDocumentInfo
+  resp.data #=> instance of ONEAccess::DataObject::ResearchDocumentInfo
   resp.data.url #=> url of the document
   resp.data.title #=> document's title
   resp.data.saml #=> instance of ONEAccess::DataObject::SAMLInfo
@@ -91,9 +91,9 @@ Similar to the previous method, this method retrieves a research document by pro
 #### How to use:
 ```ruby
 begin
-  resp = ONEAccess::API::Research.document_by_user_id(document_id: 2341, user_id: 805)
+  resp = ONEAccess::API::V1_1::Research.document_by_user_id(document_id: 2341, user_id: 805)
 
-  resp.data #=> instance of ONEAcess::DataObject::ResearchDocumentInfo
+  resp.data #=> instance of ONEAccess::DataObject::ResearchDocumentInfo
   resp.data.url #=> url of the document
   resp.data.title #=> document's title
   resp.data.saml #=> instance of ONEAccess::DataObject::SAMLInfo
@@ -114,10 +114,10 @@ This method retrieves a list of symbology companies by providing a `IsPrivate`,
 
 #### How to use:
 ```ruby
-resp = ONEAccess::API::Symbology.companies(is_private: false, page_number: 0, page_size: 20)
+resp = ONEAccess::API::V1_1::Symbology.companies(is_private: false, page_number: 0, page_size: 20)
 
-resp #=> instance of ONEAcess::Response::CompaniesResponse
-resp.data #=> instance of Array containing ONEAcess::DataObject::CompanyLight
+resp #=> instance of ONEAccess::Response::CompaniesResponse
+resp.data #=> instance of Array containing ONEAccess::DataObject::CompanyLight
 
 end
 ```
@@ -129,10 +129,10 @@ This method retrieves a company by providing an `Id`.
 
 #### How to use:
 ```ruby
-resp = ONEAccess::API::Symbology.company(id: 1)
+resp = ONEAccess::API::V1_1::Symbology.company(id: 1)
 
-resp #=> instance of ONEAcess::Response::CompanyResponse
-resp.data #=> instance of Array containing ONEAcess::DataObject::Company
+resp #=> instance of ONEAccess::Response::CompanyResponse
+resp.data #=> instance of Array containing ONEAccess::DataObject::Company
 
 end
 ```
@@ -144,9 +144,9 @@ This method returns an Organization by providing the Organization ID.
 
 #### How to use:
 ```ruby
-resp = ONEAccess::API::Organizations.get_organization(id: 123)
+resp = ONEAccess::API::V1_1::Organizations.get_organization(id: 123)
 
-resp.data #=> instance of ONEAcess::DataObject::Organization
+resp.data #=> instance of ONEAccess::DataObject::Organization
 resp.data.id #=> id of the Organization
 resp.data.name #=> name of the Organization
 resp.data.short_name #=> Short Name of the Organization
@@ -167,7 +167,7 @@ Creates a new Research Entitlement Request for the given User.
 #### How to use
 ```ruby
 begin
-  resp = ONEAccess::API::Entitlement::Research::UserRequests.create(user_id:'123', sell_side_org_id:'456',
+  resp = ONEAccess::API::V1_1::Entitlement::Research::UserRequests.create(user_id:'123', sell_side_org_id:'456',
          sales_contact_first_name:'John', sales_contact_last_name:'Doe', sales_contact_email:'john.doe@example.com')
 
   resp.data #=> ID of the new Request
@@ -184,9 +184,9 @@ This method returns a list of user entitlement requests based on the specified `
 #### How to use:
 ```ruby
 begin
-  resp = ONEAccess::API::Entitlement::Research::UserRequests.get_list
+  resp = ONEAccess::API::V1_1::Entitlement::Research::UserRequests.get_list
 
-  resp.data #=> Array of instances of ONEAcess::DataObject::UserEntitlementRequest
+  resp.data #=> Array of instances of ONEAccess::DataObject::UserEntitlementRequest
 rescue ONEAccess::Error::APIError => e
   puts "Error listing the available user entitlement requests"
 end
@@ -201,9 +201,9 @@ to receive updates from. Returns the API Status Code as the result of the subscr
 #### How to use:
 ```ruby
 begin
-  resp = ONEAccess::API::Entitlement::UserSubscription.subscribe(user_ids: [<user_ids>])
+  resp = ONEAccess::API::V1_1::Entitlement::UserSubscription.subscribe(user_ids: [<user_ids>])
 
-  resp #=> instance of ONEAcess::Response::SubscribeToUpdatesResponse
+  resp #=> instance of ONEAccess::Response::SubscribeToUpdatesResponse
 rescue ONEAccess::Error::APIError => e
   puts "Error subscribing users for entitlements updates"
 end
@@ -223,10 +223,26 @@ 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 = ONEAccess::API::V1_1::Entitlement::UserSubscription.changed_users(from_date: <utc_string_date>)
 
-  resp #=> instance of ONEAcess::Response::ChangedUsersResponse
+  resp #=> instance of ONEAccess::Response::ChangedUsersResponse
 rescue ONEAccess::Error::APIError => e
   puts "Error getting the list of user ids which entitlements have changed"
 end
 ```
+
+### Get Contributors _(/references/contributors)_
+Official Documentation: http://apidocs.oneaccess.io/v2.0/docs/referencescontributors
+
+Reference endpoint to help retrieve contributor IDs from names.
+
+#### How to use:
+```ruby
+begin
+  resp = ONEAccess::API::V3_0::References.contributors(contributor_names: [<names>], limit: <limit>, offset: <offset>)
+
+  resp #=> instance of ONEAccess::Response::ContributorsResponse
+rescue ONEAccess::Error::APIError => e
+  puts "Error getting the list of contributors"
+end
+```

data/lib/oneaccess.rb

@@ -2,6 +2,8 @@
 
 require "representable"
 
+require_relative "./oneaccess/http/http_client"
+
 require_relative "./oneaccess/configuration"
 require_relative "./oneaccess/serializable"
 
@@ -10,16 +12,21 @@ require_relative "./oneaccess/enum/product_type"
 require_relative "./oneaccess/enum/product_group_status"
 require_relative "./oneaccess/enum/entitlement_status"
 
-require_relative "./oneaccess/api/base"
-require_relative "./oneaccess/api/user"
-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"
+require_relative "./oneaccess/api/api_base"
+
+require_relative "./oneaccess/api/v1_1/base"
+require_relative "./oneaccess/api/v1_1/user"
+require_relative "./oneaccess/api/v1_1/research"
+require_relative "./oneaccess/api/v1_1/organizations"
+require_relative "./oneaccess/api/v1_1/symbology"
+require_relative "./oneaccess/api/v1_1/references"
+require_relative "./oneaccess/api/v1_1/entitlement/user_subscription"
+require_relative "./oneaccess/api/v1_1/entitlement/organization/product_group"
+require_relative "./oneaccess/api/v1_1/entitlement/user/product_group"
+require_relative "./oneaccess/api/v1_1/entitlement/research/user_requests"
+
+require_relative "./oneaccess/api/v3_0/base"
+require_relative "./oneaccess/api/v3_0/references"
 
 module ONEAccess
   def self.configure

data/lib/oneaccess/api/api_base.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require "rest-client"
+require "json"
+require_relative "../response/api_error"
+require_relative "../error/api_error"
+
+module ONEAccess
+  module API
+    class ApiBase
+      class << self
+        def send_get(method, params = {})
+          Http::HttpClient.get(api_url(method), params)
+        end
+
+        def send_post(method, body)
+          Http::HttpClient.post(api_url(method), body, content_type: :json)
+        end
+
+        def resource_api_path
+          const_get("RESOURCE_API_PATH")
+        rescue StandardError
+          nil
+        end
+
+        def api_url(method = nil)
+          url = "#{base_url}#{resource_api_path}"
+          return url if method.nil?
+          "#{url}/#{method}"
+        end
+
+        protected
+
+        def api_path(path)
+          raise "API path has already been set" if resource_api_path
+          self.resource_api_path = path
+        end
+
+        private
+
+        def base_url
+          raise "base_url must be implemented"
+        end
+
+        def resource_api_path=(path)
+          const_set("RESOURCE_API_PATH", path)
+        end
+      end
+    end
+  end
+end

data/lib/oneaccess/api/v1_1/base.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative "../api_base"
+
+module ONEAccess
+  module API
+    module V1_1 # rubocop:disable Style/ClassAndModuleCamelCase
+      class Base < ApiBase
+        class << self
+          private
+
+          def base_url
+            Configuration.base_v1_1_url
+          end
+        end
+      end
+    end
+  end
+end

data/lib/oneaccess/api/v1_1/entitlement/organization/product_group.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+require_relative "../../../../response/product_groups_response"
+
+module ONEAccess
+  module API
+    module V1_1 # rubocop:disable Style/ClassAndModuleCamelCase
+      module Entitlement
+        module Organization
+          class ProductGroup < Base
+            api_path "/entitlement/organization/productgroup"
+
+            def self.get_list(contributor_org_id:, page_number: 0, page_size: 20, type: nil)
+              resp = send_get("getList", Query: {
+                PageNumber:       page_number,
+                PageSize:         page_size,
+                ContributorOrgId: contributor_org_id,
+                Type:             type
+              }.to_json)
+              Response::ProductGroupsResponse.from_json(resp.body)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/oneaccess/api/v1_1/entitlement/research/user_requests.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require_relative "../../../../response/user_requests_response"
+require_relative "../../../../response/user_entitlement_requests_response"
+
+module ONEAccess
+  module API
+    module V1_1 # rubocop:disable Style/ClassAndModuleCamelCase
+      module Entitlement
+        module Research
+          class UserRequests < Base
+            api_path "/entitlement/research/userRequests"
+
+            def self.create(user_id:, sell_side_org_id:, sales_contact_first_name: nil, sales_contact_last_name: nil,
+                            sales_contact_email: nil)
+              response = send_post("create",
+                                   UserId:        user_id,
+                                   SellSideOrgId: sell_side_org_id,
+                                   SalesContact:  {
+                                     FirstName: sales_contact_first_name,
+                                     LastName:  sales_contact_last_name,
+                                     Email:     sales_contact_email
+                                   }.reject { |_, value| value.nil? })
+
+              Response::UserRequestsResponse.from_json(response.body)
+            end
+
+            def self.get_list( # rubocop:disable Metrics/ParameterLists, Metrics/MethodLength
+              user_ids: [],
+              page_number: 0,
+              page_size: 20,
+              sort_by: "UserEntitlementRequestId",
+              is_ascending: false,
+              create_date_from: nil,
+              create_date_to: nil,
+              sell_side_org_ids: nil,
+              entitlement_status: nil
+            )
+              query = {
+                UserIds:           user_ids,
+                PageNumber:        page_number,
+                PageSize:          page_size,
+                SortBy:            sort_by,
+                IsAscending:       is_ascending,
+                CreateDateFrom:    create_date_from,
+                CreateDateTo:      create_date_to,
+                SellSideOrgIds:    sell_side_org_ids,
+                EntitlementStatus: entitlement_status
+              }.reject { |_, value| value.nil? }
+
+              response = send_get("getListWithEntitlementsStatus", Query: query.to_json)
+
+              Response::UserEntitlementRequestsResponse.from_json(response.body)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/oneaccess/api/v1_1/entitlement/user/product_group.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+require_relative "../../../../response/product_groups_response"
+
+module ONEAccess
+  module API
+    module V1_1 # rubocop:disable Style/ClassAndModuleCamelCase
+      module Entitlement
+        module User
+          class ProductGroup < Base
+            api_path "/entitlement/user/productgroup"
+
+            def self.get_list(user_id:, page_number: 0, page_size: 20, type: nil)
+              resp = send_get("getList", Query: {
+                PageNumber: page_number,
+                PageSize:   page_size,
+                UserId:     user_id,
+                Type:       type
+              }.to_json)
+              Response::ProductGroupsResponse.from_json(resp.body)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative "../../../response/subscribe_to_updates_response"
+require_relative "../../../response/changed_users_response"
+
+module ONEAccess
+  module API
+    module V1_1 # rubocop:disable Style/ClassAndModuleCamelCase
+      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
+end

data/lib/oneaccess/api/v1_1/organizations.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative "../../response/organization_response"
+
+module ONEAccess
+  module API
+    module V1_1 # rubocop:disable Style/ClassAndModuleCamelCase
+      class Organizations < Base
+        api_path "/organizations"
+
+        def self.get(id:)
+          resp = send_get("get/#{id}")
+          Response::OrganizationResponse.from_json(resp.body)
+        end
+      end
+    end
+  end
+end

data/lib/oneaccess/api/v1_1/references.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative "../../response/industries_response"
+require_relative "../../response/countries_response"
+require_relative "../../response/contributors_response"
+
+module ONEAccess
+  module API
+    module V1_1 # rubocop:disable Style/ClassAndModuleCamelCase
+      class References < Base
+        api_path "/references"
+
+        class << self
+          def industries(sort_by: "Id", is_ascending: false, keyword: "", page_number: 0, page_size: 20)
+            query = build_query(sort_by, is_ascending, keyword, page_number, page_size)
+
+            resp = send_get("industries", Query: query.to_json)
+
+            Response::IndustriesResponse.from_json(resp.body)
+          end
+
+          def countries(sort_by: "Id", is_ascending: false, keyword: "", page_number: 0, page_size: 20)
+            query = build_query(sort_by, is_ascending, keyword, page_number, page_size)
+
+            resp = send_get("countries", Query: query.to_json)
+
+            Response::CountriesResponse.from_json(resp.body)
+          end
+
+          private
+
+          def build_query(sort_by, is_ascending, keyword, page_number, page_size)
+            {
+              SortBy:      sort_by,
+              IsAscending: is_ascending,
+              Keyword:     keyword,
+              PageNumber:  page_number,
+              PageSize:    page_size
+            }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/oneaccess/api/v1_1/research.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+require_relative "../../response/research_document_response"
+
+module ONEAccess
+  module API
+    module V1_1 # rubocop:disable Style/ClassAndModuleCamelCase
+      class Research < Base
+        api_path "/research"
+
+        def self.document(document_id:, first_name:, last_name:, email:)
+          resp = send_get("document", documentId: document_id, userFirstName: first_name,
+            userLastName: last_name, userEmail: email)
+          Response::ResearchDocumentResponse.from_json(resp.body)
+        end
+
+        def self.document_by_user_id(document_id:, user_id:)
+          resp = send_get("documentByUserId", documentId: document_id, userId: user_id)
+          Response::ResearchDocumentResponse.from_json(resp.body)
+        end
+      end
+    end
+  end
+end

data/lib/oneaccess/api/v1_1/symbology.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative "../../response/companies_response"
+require_relative "../../response/company_response"
+
+module ONEAccess
+  module API
+    module V1_1 # rubocop:disable Style/ClassAndModuleCamelCase
+      class Symbology < Base
+        api_path "/symbology"
+
+        def self.companies(is_private:, page_number: 0, page_size: 20)
+          resp = send_get("companies", Query: {
+            PageNumber: page_number,
+            PageSize:   page_size,
+            IsPrivate:  is_private
+          }.to_json)
+          Response::CompaniesResponse.from_json(resp.body)
+        end
+
+        def self.company(id:)
+          resp = send_get("companies/#{id}")
+          Response::CompanyResponse.from_json(resp.body)
+        end
+      end
+    end
+  end
+end

data/lib/oneaccess/api/v1_1/user.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+require_relative "../../response/user_response"
+
+module ONEAccess
+  module API
+    module V1_1 # rubocop:disable Style/ClassAndModuleCamelCase
+      class User < Base
+        api_path "/user"
+
+        def self.get_by_email(first_name:, last_name:, email:)
+          resp = send_get("getbyemail", userFirstName: first_name, userLastName: last_name, userEmail: email)
+          Response::UserResponse.from_json(resp.body)
+        end
+      end
+    end
+  end
+end

data/lib/oneaccess/api/v3_0/base.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative "../api_base"
+
+module ONEAccess
+  module API
+    module V3_0 # rubocop:disable Style/ClassAndModuleCamelCase
+      class Base < ApiBase
+        class << self
+          private
+
+          def base_url
+            Configuration.base_v3_0_url
+          end
+        end
+      end
+    end
+  end
+end

data/lib/oneaccess/api/v3_0/references.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "../../response/contributors_response"
+require_relative "../../request/contributors_request_handler"
+
+module ONEAccess
+  module API
+    module V3_0 # rubocop:disable Style/ClassAndModuleCamelCase
+      class References < Base
+        api_path "/references"
+
+        class << self
+          def contributors(contributor_names: nil, limit: 20, offset: 0)
+            params = {
+              contributor_names: contributor_names,
+              limit:             limit,
+              offset:            offset
+            }.reject { |_, v| v.nil? }
+
+            resp = send_get("contributors", params)
+
+            Response::ContributorsResponse.from_json(resp.body)
+          end
+
+          def contributors_list
+            Request::ContributorsRequestHandler.new(url: api_url("contributors"))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/oneaccess/configuration.rb

@@ -1,14 +1,17 @@
 # frozen_string_literal: true
 module ONEAccess
   class Configuration
-    DEFAULT_BASE_URL = "http://ws.oneaccess.io/v1.1"
+    DEFAULT_BASE_V1_1_URL = "http://ws.oneaccess.io/v1.1"
+    DEFAULT_BASE_V3_0_URL = "http://ws.oneaccess.io/v3.0"
 
     class << self
-      attr_accessor :base_url
+      attr_accessor :base_v1_1_url
+      attr_accessor :base_v3_0_url
       attr_accessor :api_key
       attr_accessor :master_api_key
     end
 
-    self.base_url = DEFAULT_BASE_URL
+    self.base_v1_1_url = DEFAULT_BASE_V1_1_URL
+    self.base_v3_0_url = DEFAULT_BASE_V3_0_URL
   end
 end

data/lib/oneaccess/data_object/contributor.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative "./representer/contributor"
+
+module ONEAccess
+  module DataObject
+    class Contributor
+      extend Serializable
+
+      represented_by Representer::Contributor
+
+      attr_accessor :contributor_id
+      attr_accessor :contributor_name
+      attr_accessor :contributor_shortname
+      attr_accessor :active
+
+      alias active? active
+    end
+  end
+end

data/lib/oneaccess/data_object/meta.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+require_relative "./representer/meta"
+
+module ONEAccess
+  module DataObject
+    class Meta
+      extend Serializable
+
+      represented_by Representer::Meta
+
+      attr_accessor :total
+      attr_accessor :limit
+      attr_accessor :offset
+    end
+  end
+end

data/lib/oneaccess/data_object/representer/contributor.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module ONEAccess
+  module DataObject
+    module Representer
+      class Contributor < Representable::Decorator
+        include Representable::JSON
+
+        property :contributor_id,        type: Integer
+        property :contributor_name,      type: String
+        property :contributor_shortname, type: String
+        property :active
+      end
+    end
+  end
+end

data/lib/oneaccess/data_object/representer/meta.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module ONEAccess
+  module DataObject
+    module Representer
+      class Meta < Representable::Decorator
+        include Representable::JSON
+
+        property :total,  type: Integer
+        property :limit,  type: Integer
+        property :offset, type: Integer
+      end
+    end
+  end
+end

data/lib/oneaccess/http/http_client.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module ONEAccess
+  module Http
+    class HttpClient
+      class << self
+        def get(url, params = {})
+          RestClient.get(url, { params: params }.merge(auth_headers))
+        rescue RestClient::Exception => e
+          raise create_api_error(e)
+        end
+
+        def post(url, body, headers = {})
+          RestClient.post(url, body.to_json, headers.merge(auth_headers))
+        rescue RestClient::Exception => e
+          raise create_api_error(e)
+        end
+
+        private
+
+        def create_api_error(error)
+          api_error_data = Response::APIError.new
+          Response::Representer::APIError.new(api_error_data).from_json(error.http_body)
+          Error::APIError.new(error.http_code, api_error_data.api_status_code, api_error_data.api_status_message)
+        end
+
+        def auth_headers
+          {
+            "X-One-Access-Api-Key" => Configuration.api_key,
+            "Authorization"        => "X-One-Access-Master-Api-Key #{Configuration.master_api_key}"
+          }
+        end
+      end
+    end
+  end
+end

data/lib/oneaccess/request/contributors_request_handler.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative "../response/contributors_response"
+
+module ONEAccess
+  module Request
+    class ContributorsRequestHandler
+      def initialize(url:, limit: PAGE_SIZE)
+        @url = url
+        @limit = limit
+      end
+
+      def each
+        offset = 0
+        loop do
+          http_response = Http::HttpClient.get(url, build_params(offset))
+          response = Response::ContributorsResponse.from_json(http_response.body)
+          response&.data&.each do |contributor|
+            yield contributor
+          end
+          break unless more_records?(response.meta)
+          offset += 1
+        end
+      end
+
+      private
+
+      PAGE_SIZE = 200
+
+      attr_reader :url
+      attr_reader :limit
+
+      def build_params(offset)
+        {
+          limit:  limit,
+          offset: offset
+        }
+      end
+
+      def more_records?(meta)
+        meta.offset < (meta.total / meta.limit).ceil - 1
+      end
+    end
+  end
+end

data/lib/oneaccess/response/contributors_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative "./base_response"
+require_relative "./representer/contributors_response"
+
+module ONEAccess
+  module Response
+    class ContributorsResponse
+      extend Serializable
+      represented_by Representer::ContributorsResponse
+
+      attr_accessor :meta
+      attr_accessor :data
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative "./base_response"
+require_relative "../../data_object/meta"
+require_relative "../../data_object/contributor"
+
+module ONEAccess
+  module Response
+    module Representer
+      class ContributorsResponse < Representable::Decorator
+        include Representable::JSON
+
+        property :meta,   decorator: DataObject::Representer::Meta,
+                          class:     DataObject::Meta
+        collection :data, decorator: DataObject::Representer::Contributor,
+                          class:     DataObject::Contributor
+      end
+    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.9"
-  s.date          = "2018-01-29"
+  s.version       = "0.2.0"
+  s.date          = "2018-02-04"
   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.9
+  version: 0.2.0
 platform: ruby
 authors:
 - Alex Correia Santos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-29 00:00:00.000000000 Z
+date: 2018-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -186,24 +186,29 @@ files:
 - console
 - docker-compose.yml
 - lib/oneaccess.rb
-- lib/oneaccess/api/base.rb
-- 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
-- lib/oneaccess/api/symbology.rb
-- lib/oneaccess/api/user.rb
+- lib/oneaccess/api/api_base.rb
+- lib/oneaccess/api/v1_1/base.rb
+- lib/oneaccess/api/v1_1/entitlement/organization/product_group.rb
+- lib/oneaccess/api/v1_1/entitlement/research/user_requests.rb
+- lib/oneaccess/api/v1_1/entitlement/user/product_group.rb
+- lib/oneaccess/api/v1_1/entitlement/user_subscription.rb
+- lib/oneaccess/api/v1_1/organizations.rb
+- lib/oneaccess/api/v1_1/references.rb
+- lib/oneaccess/api/v1_1/research.rb
+- lib/oneaccess/api/v1_1/symbology.rb
+- lib/oneaccess/api/v1_1/user.rb
+- lib/oneaccess/api/v3_0/base.rb
+- lib/oneaccess/api/v3_0/references.rb
 - lib/oneaccess/configuration.rb
 - lib/oneaccess/data_object/address.rb
 - lib/oneaccess/data_object/city.rb
 - lib/oneaccess/data_object/company.rb
 - lib/oneaccess/data_object/company_light.rb
+- lib/oneaccess/data_object/contributor.rb
 - lib/oneaccess/data_object/country.rb
 - lib/oneaccess/data_object/global_region.rb
 - lib/oneaccess/data_object/industry.rb
+- lib/oneaccess/data_object/meta.rb
 - lib/oneaccess/data_object/organization.rb
 - lib/oneaccess/data_object/organization_light.rb
 - lib/oneaccess/data_object/product_group.rb
@@ -212,9 +217,11 @@ files:
 - lib/oneaccess/data_object/representer/city.rb
 - lib/oneaccess/data_object/representer/company.rb
 - lib/oneaccess/data_object/representer/company_light.rb
+- lib/oneaccess/data_object/representer/contributor.rb
 - lib/oneaccess/data_object/representer/country.rb
 - lib/oneaccess/data_object/representer/global_region.rb
 - lib/oneaccess/data_object/representer/industry.rb
+- lib/oneaccess/data_object/representer/meta.rb
 - lib/oneaccess/data_object/representer/organization.rb
 - lib/oneaccess/data_object/representer/organization_light.rb
 - lib/oneaccess/data_object/representer/product_group.rb
@@ -236,11 +243,14 @@ files:
 - lib/oneaccess/enum/product_group_status.rb
 - lib/oneaccess/enum/product_type.rb
 - lib/oneaccess/error/api_error.rb
+- lib/oneaccess/http/http_client.rb
+- lib/oneaccess/request/contributors_request_handler.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/contributors_response.rb
 - lib/oneaccess/response/countries_response.rb
 - lib/oneaccess/response/industries_response.rb
 - lib/oneaccess/response/organization_response.rb
@@ -251,6 +261,7 @@ files:
 - 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/contributors_response.rb
 - lib/oneaccess/response/representer/countries_response.rb
 - lib/oneaccess/response/representer/industries_response.rb
 - lib/oneaccess/response/representer/organization_response.rb

data/lib/oneaccess/api/base.rb

@@ -1,64 +0,0 @@
-# frozen_string_literal: true
-
-require "rest-client"
-require "json"
-require_relative "../response/api_error"
-require_relative "../error/api_error"
-
-module ONEAccess
-  module API
-    class Base
-      class << self
-        def send_get(method, params = {})
-          RestClient.get(api_url(method), { params: params }.merge(auth_headers))
-        rescue RestClient::Exception => e
-          raise create_api_error(e)
-        end
-
-        def send_post(method, body)
-          RestClient.post(api_url(method), body.to_json, { content_type: :json }.merge(auth_headers))
-        rescue RestClient::Exception => e
-          raise create_api_error(e)
-        end
-
-        def resource_api_path
-          const_get("RESOURCE_API_PATH")
-        rescue StandardError
-          nil
-        end
-
-        def api_url(method = nil)
-          url = "#{Configuration.base_url}#{resource_api_path}"
-          return url if method.nil?
-          "#{url}/#{method}"
-        end
-
-        protected
-
-        def api_path(path)
-          raise "API path has already been set" if resource_api_path
-          self.resource_api_path = path
-        end
-
-        private
-
-        def create_api_error(error)
-          api_error_data = Response::APIError.new
-          Response::Representer::APIError.new(api_error_data).from_json(error.http_body)
-          Error::APIError.new(error.http_code, api_error_data.api_status_code, api_error_data.api_status_message)
-        end
-
-        def resource_api_path=(path)
-          const_set("RESOURCE_API_PATH", path)
-        end
-
-        def auth_headers
-          {
-            "X-One-Access-Api-Key" => Configuration.api_key,
-            "Authorization"        => "X-One-Access-Master-Api-Key #{Configuration.master_api_key}"
-          }
-        end
-      end
-    end
-  end
-end

data/lib/oneaccess/api/entitlement/organization/product_group.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-require_relative "../../../response/product_groups_response"
-
-module ONEAccess
-  module API
-    module Entitlement
-      module Organization
-        class ProductGroup < Base
-          api_path "/entitlement/organization/productgroup"
-
-          def self.get_list(contributor_org_id:, page_number: 0, page_size: 20, type: nil)
-            resp = send_get("getList", Query: {
-              PageNumber:       page_number,
-              PageSize:         page_size,
-              ContributorOrgId: contributor_org_id,
-              Type:             type
-            }.to_json)
-            Response::ProductGroupsResponse.from_json(resp.body)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/oneaccess/api/entitlement/research/user_requests.rb

@@ -1,58 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "../../../response/user_requests_response"
-require_relative "../../../response/user_entitlement_requests_response"
-
-module ONEAccess
-  module API
-    module Entitlement
-      module Research
-        class UserRequests < Base
-          api_path "/entitlement/research/userRequests"
-
-          def self.create(user_id:, sell_side_org_id:, sales_contact_first_name: nil, sales_contact_last_name: nil,
-                          sales_contact_email: nil)
-            response = send_post("create",
-                                 UserId:        user_id,
-                                 SellSideOrgId: sell_side_org_id,
-                                 SalesContact:  {
-                                   FirstName: sales_contact_first_name,
-                                   LastName:  sales_contact_last_name,
-                                   Email:     sales_contact_email
-                                 }.reject { |_, value| value.nil? })
-
-            Response::UserRequestsResponse.from_json(response.body)
-          end
-
-          def self.get_list( # rubocop:disable Metrics/ParameterLists, Metrics/MethodLength
-            user_ids: [],
-            page_number: 0,
-            page_size: 20,
-            sort_by: "UserEntitlementRequestId",
-            is_ascending: false,
-            create_date_from: nil,
-            create_date_to: nil,
-            sell_side_org_ids: nil,
-            entitlement_status: nil
-          )
-            query = {
-              UserIds:           user_ids,
-              PageNumber:        page_number,
-              PageSize:          page_size,
-              SortBy:            sort_by,
-              IsAscending:       is_ascending,
-              CreateDateFrom:    create_date_from,
-              CreateDateTo:      create_date_to,
-              SellSideOrgIds:    sell_side_org_ids,
-              EntitlementStatus: entitlement_status
-            }.reject { |_, value| value.nil? }
-
-            response = send_get("getListWithEntitlementsStatus", Query: query.to_json)
-
-            Response::UserEntitlementRequestsResponse.from_json(response.body)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/oneaccess/api/entitlement/user/product_group.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-require_relative "../../../response/product_groups_response"
-
-module ONEAccess
-  module API
-    module Entitlement
-      module User
-        class ProductGroup < Base
-          api_path "/entitlement/user/productgroup"
-
-          def self.get_list(user_id:, page_number: 0, page_size: 20, type: nil)
-            resp = send_get("getList", Query: {
-              PageNumber: page_number,
-              PageSize:   page_size,
-              UserId:     user_id,
-              Type:       type
-            }.to_json)
-            Response::ProductGroupsResponse.from_json(resp.body)
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,27 +0,0 @@
-# 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/api/organizations.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "../response/organization_response"
-
-module ONEAccess
-  module API
-    class Organizations < Base
-      api_path "/organizations"
-
-      def self.get(id:)
-        resp = send_get("get/#{id}")
-        Response::OrganizationResponse.from_json(resp.body)
-      end
-    end
-  end
-end

data/lib/oneaccess/api/references.rb

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "../response/industries_response"
-require_relative "../response/countries_response"
-
-module ONEAccess
-  module API
-    class References < Base
-      api_path "/references"
-
-      class << self
-        def industries(sort_by: "Id", is_ascending: false, keyword: "", page_number: 0, page_size: 20)
-          query = build_query(sort_by, is_ascending, keyword, page_number, page_size)
-
-          resp = send_get("industries", Query: query.to_json)
-
-          Response::IndustriesResponse.from_json(resp.body)
-        end
-
-        def countries(sort_by: "Id", is_ascending: false, keyword: "", page_number: 0, page_size: 20)
-          query = build_query(sort_by, is_ascending, keyword, page_number, page_size)
-
-          resp = send_get("countries", Query: query.to_json)
-
-          Response::CountriesResponse.from_json(resp.body)
-        end
-
-        private
-
-        def build_query(sort_by, is_ascending, keyword, page_number, page_size)
-          {
-            SortBy:      sort_by,
-            IsAscending: is_ascending,
-            Keyword:     keyword,
-            PageNumber:  page_number,
-            PageSize:    page_size
-          }
-        end
-      end
-    end
-  end
-end

data/lib/oneaccess/api/research.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-require_relative "../response/research_document_response"
-
-module ONEAccess
-  module API
-    class Research < Base
-      api_path "/research"
-
-      def self.document(document_id:, first_name:, last_name:, email:)
-        resp = send_get("document", documentId: document_id, userFirstName: first_name,
-          userLastName: last_name, userEmail: email)
-        Response::ResearchDocumentResponse.from_json(resp.body)
-      end
-
-      def self.document_by_user_id(document_id:, user_id:)
-        resp = send_get("documentByUserId", documentId: document_id, userId: user_id)
-        Response::ResearchDocumentResponse.from_json(resp.body)
-      end
-    end
-  end
-end

data/lib/oneaccess/api/symbology.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "../response/companies_response"
-require_relative "../response/company_response"
-
-module ONEAccess
-  module API
-    class Symbology < Base
-      api_path "/symbology"
-
-      def self.companies(is_private:, page_number: 0, page_size: 20)
-        resp = send_get("companies", Query: {
-          PageNumber: page_number,
-          PageSize:   page_size,
-          IsPrivate:  is_private
-        }.to_json)
-        Response::CompaniesResponse.from_json(resp.body)
-      end
-
-      def self.company(id:)
-        resp = send_get("companies/#{id}")
-        Response::CompanyResponse.from_json(resp.body)
-      end
-    end
-  end
-end

data/lib/oneaccess/api/user.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-require_relative "../response/user_response"
-
-module ONEAccess
-  module API
-    class User < Base
-      api_path "/user"
-
-      def self.get_by_email(first_name:, last_name:, email:)
-        resp = send_get("getbyemail", userFirstName: first_name, userLastName: last_name, userEmail: email)
-        Response::UserResponse.from_json(resp.body)
-      end
-    end
-  end
-end