oneaccess 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c40d4f0b9e451ae7913454d558de37997bb6ee8e
-  data.tar.gz: af37d616c60b5c93c709c7a2002d8c147a7de023
+SHA256:
+  metadata.gz: 3ebe5e722b86a12e04a090edd457e91856909846b1b5e091a314b069714f4e93
+  data.tar.gz: 731c3ba2533b4cd9e32ff2112f0a8795767d140e32a335969de257927fb03c8f
 SHA512:
-  metadata.gz: abc576b91ce4b23ad091b487e9894bb2f169c191d2cfe296710c71bd1aa1da45bbc92837ec7ae7cede6f203fe118f9993e29c29f55591f6c1156ed4f58a058b8
-  data.tar.gz: 89b0ccd89e1996babc10fc10a650b533d1f169f979e47ffebf91245c9bfc7b4e0e08ecfa7f440c52db747c5ebe305240acc74d31dbb13a007643ba46ec151268
+  metadata.gz: e7c36727bebc3b7512837d14b37e835d1ca617e9da4d0fc2839dd242717d7bfd4a73b4e6824a99a3cf7a27f97c0e0aa073b144e7e3ccf2475abe4db4c312dccf
+  data.tar.gz: 840a71ffb4726dd71a7a33694a4f0d645c52c376cb9fe36ce0c2495149608fb4a2b1b197e749bdd85e66948b0309afa0b420e534878d1131ef085598c3fe1f3c

data/.circleci/config.yml

@@ -0,0 +1,24 @@
+version: 2
+jobs:
+  build:
+    docker:
+      - image: circleci/ruby:2.4.3-node
+
+    steps:
+      - checkout
+      - restore_cache:
+          keys:
+            - oneaccess-rb-bundle-v1-{{ checksum "Gemfile.lock" }}
+      - run:
+          name: Install Dependencies
+          command: bundle check --path=vendor/bundle || bundle install --path=vendor/bundle --jobs=4 --retry=3
+      - save_cache:
+          key: oneaccess-rb-bundle-v1-{{ checksum "Gemfile.lock" }}
+          paths:
+            - vendor/bundle
+      - run:
+          name: Linting
+          command: bundle exec rubocop
+      - run:
+          name: Test
+          command: bundle exec rspec

data/.rubocop.yml

@@ -1,35 +1,17 @@
-Style/Documentation:
-  Enabled: false
+inherit_gem:
+  va-ruby-style:
+    - default.yml
 
-Naming/ClassAndModuleCamelCase:
-  Enabled: false
-
-Style/StringLiterals:
-  EnforcedStyle: double_quotes
-
-Layout/AlignHash:
-  EnforcedHashRocketStyle: table
-  EnforcedColonStyle: table
-
-Metrics/ClassLength:
-  Max: 120
-
-Metrics/AbcSize:
-  Max: 18
-
-Metrics/ParameterLists:
-  Max: 7
-  CountKeywordArgs: false
-
-Metrics/LineLength:
-  Max: 120
+inherit_from: .rubocop_todo.yml
 
 AllCops:
-  TargetRubyVersion: 2.4
-  DisplayCopNames: true
-  DisplayStyleGuide: true
   Exclude:
     - 'spec/**/*'
-    - 'test/**/*'
-    - 'vendor/**/*'
     - 'bin/**/*'
+    - 'vendor/**/*'
+
+Style/MethodCallWithArgsParentheses:
+  Exclude:
+    - Gemfile
+    - Rakefile
+    - '*.gemspec'

data/.rubocop_todo.yml

@@ -0,0 +1,50 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2018-10-04 16:17:48 +0000 using RuboCop version 0.55.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 11
+
+# Offense count: 4
+# Configuration parameters: CountKeywordArgs.
+Metrics/ParameterLists:
+  Max: 9
+
+# Offense count: 14
+Naming/ClassAndModuleCamelCase:
+  Exclude:
+    - '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/model/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/interactions.rb'
+    - 'lib/oneaccess/api/v3_0/providers.rb'
+    - 'lib/oneaccess/api/v3_0/references.rb'
+
+# Offense count: 4
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: strict, flexible
+Rails/TimeZone:
+  Exclude:
+    - 'lib/oneaccess/data_object/representer/inducement.rb'
+    - 'lib/oneaccess/data_object/representer/user_entitlement_request.rb'
+
+# Offense count: 45
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 117

data/Gemfile

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 gemspec

data/Gemfile.lock

@@ -28,9 +28,9 @@ GEM
     multi_json (1.12.2)
     multipart-post (2.0.0)
     parallel (1.12.1)
-    parser (2.5.1.0)
+    parser (2.5.1.2)
       ast (~> 2.4.0)
-    powerpack (0.1.1)
+    powerpack (0.1.2)
     public_suffix (2.0.5)
     rainbow (3.0.0)
     rake (11.3.0)
@@ -61,7 +61,7 @@ GEM
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
-    ruby-progressbar (1.9.0)
+    ruby-progressbar (1.10.0)
     safe_yaml (1.0.4)
     simplecov (0.15.1)
       docile (~> 1.1.0)
@@ -72,8 +72,12 @@ GEM
       hirb
       simplecov
     simplecov-html (0.10.2)
+    thor (0.19.4)
     uber (0.1.0)
-    unicode-display_width (1.3.2)
+    unicode-display_width (1.4.0)
+    va-ruby-style (0.0.1)
+      rubocop (= 0.55.0)
+      thor (= 0.19.4)
     webmock (3.0.1)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
@@ -89,9 +93,9 @@ DEPENDENCIES
   rake (~> 11.3)
   rspec (~> 3.6)
   rspec-its (~> 1.2)
-  rubocop (~> 0.55.0)
   simplecov
   simplecov-console
+  va-ruby-style (= 0.0.1)
   webmock (~> 3.0.1)
 
 BUNDLED WITH

data/Rakefile

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require "bundler/gem_tasks"
-require "rake/testtask"
+require 'bundler/gem_tasks'
+require 'rake/testtask'
 
 Rake::TestTask.new do |t|
-  t.test_files = FileList["test/**/*_test.rb"]
+  t.test_files = FileList['test/**/*_test.rb']
 end
-desc "Run tests"
+desc 'Run tests'
 
 task default: :test

data/docker-compose.yml

@@ -8,10 +8,5 @@ services:
       - .:/oneaccess-rb
       - bundler-cache:/bundle
 
-  bundle:
-    image: tianon/true
-    volumes:
-      - bundler-cache:/bundle
-
 volumes:
   bundler-cache:

data/lib/oneaccess.rb

@@ -1,38 +1,39 @@
 # frozen_string_literal: true
 
-require "representable"
+require 'representable'
 
-require_relative "./oneaccess/http/http_client"
+require_relative './oneaccess/http/http_client'
 
-require_relative "./oneaccess/configuration"
-require_relative "./oneaccess/serializable"
+require_relative './oneaccess/configuration'
+require_relative './oneaccess/serializable'
 
-require_relative "./oneaccess/enum/api_status_code"
-require_relative "./oneaccess/enum/product_type"
-require_relative "./oneaccess/enum/product_group_status"
-require_relative "./oneaccess/enum/entitlement_status"
+require_relative './oneaccess/enum/api_status_code'
+require_relative './oneaccess/enum/product_type'
+require_relative './oneaccess/enum/product_group_status'
+require_relative './oneaccess/enum/entitlement_status'
 
-require_relative "./oneaccess/api/api_base"
+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/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/v1_1/entitlement/model/user_requests'
 
-require_relative "./oneaccess/api/v3_0/base"
-require_relative "./oneaccess/api/v3_0/references"
-require_relative "./oneaccess/api/v3_0/providers"
-require_relative "./oneaccess/api/v3_0/interactions"
+require_relative './oneaccess/api/v3_0/base'
+require_relative './oneaccess/api/v3_0/references'
+require_relative './oneaccess/api/v3_0/providers'
+require_relative './oneaccess/api/v3_0/interactions'
 
 module ONEAccess
   def self.configure
-    raise "expected block for configuration" unless block_given?
+    raise 'expected block for configuration' unless block_given?
     yield Configuration
   end
 end

data/lib/oneaccess/api/api_base.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require "faraday"
-require "json"
-require_relative "../response/api_error"
-require_relative "../error/api_error"
+require 'faraday'
+require 'json'
+require_relative '../response/api_error'
+require_relative '../error/api_error'
 
 module ONEAccess
   module API
@@ -14,11 +14,11 @@ module ONEAccess
         end
 
         def send_post(method, body)
-          Http::HttpClient.post(api_url(method), body, "Content-Type" => "application/json")
+          Http::HttpClient.post(api_url(method), body, 'Content-Type' => 'application/json')
         end
 
         def resource_api_path
-          const_get("RESOURCE_API_PATH")
+          const_get('RESOURCE_API_PATH')
         rescue StandardError
           nil
         end
@@ -32,18 +32,18 @@ module ONEAccess
         protected
 
         def api_path(path)
-          raise "API path has already been set" if resource_api_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"
+          raise 'base_url must be implemented'
         end
 
         def resource_api_path=(path)
-          const_set("RESOURCE_API_PATH", path)
+          const_set('RESOURCE_API_PATH', path)
         end
       end
     end

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "../api_base"
+require_relative '../api_base'
 
 module ONEAccess
   module API

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

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require_relative '../../../../response/user_requests_response'
+require_relative '../../../../response/user_entitlement_requests_response'
+
+module ONEAccess
+  module API
+    module V1_1
+      module Entitlement
+        module Model
+          class UserRequests < Base
+            api_path '/entitlement/model/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/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/organization/product_group.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "../../../../response/product_groups_response"
+require_relative '../../../../response/product_groups_response'
 
 module ONEAccess
   module API
@@ -8,15 +8,17 @@ module ONEAccess
       module Entitlement
         module Organization
           class ProductGroup < Base
-            api_path "/entitlement/organization/productgroup"
+            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)
+              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

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require_relative "../../../../response/user_requests_response"
-require_relative "../../../../response/user_entitlement_requests_response"
+require_relative '../../../../response/user_requests_response'
+require_relative '../../../../response/user_entitlement_requests_response'
 
 module ONEAccess
   module API
@@ -9,18 +9,20 @@ module ONEAccess
       module Entitlement
         module Research
           class UserRequests < Base
-            api_path "/entitlement/research/userRequests"
+            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? })
+              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
@@ -29,7 +31,7 @@ module ONEAccess
               user_ids: [],
               page_number: 0,
               page_size: 20,
-              sort_by: "UserEntitlementRequestId",
+              sort_by: 'UserEntitlementRequestId',
               is_ascending: false,
               create_date_from: nil,
               create_date_to: nil,
@@ -45,10 +47,10 @@ module ONEAccess
                 CreateDateFrom:    create_date_from,
                 CreateDateTo:      create_date_to,
                 SellSideOrgIds:    sell_side_org_ids,
-                EntitlementStatus: entitlement_status
+                EntitlementStatus: entitlement_status,
               }.reject { |_, value| value.nil? }
 
-              response = send_get("getListWithEntitlementsStatus", Query: query.to_json)
+              response = send_get('getListWithEntitlementsStatus', Query: query.to_json)
 
               Response::UserEntitlementRequestsResponse.from_json(response.body)
             end