oneaccess 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e961f9529c6796c037eff64b226f0db1e78763ed
-  data.tar.gz: 45cad12764af3ceb1267acb38620c79ba82c3126
+  metadata.gz: c33c036b76dd4e04030e1fbddeab3e1712b3310d
+  data.tar.gz: 3536eb9fd5be517e69b1babc00e9a5242ec34f84
 SHA512:
-  metadata.gz: 1407474d5289150000ba88aa0e6bb5bc842c7a83187ba945a5ad22dab1b0a1bf61730432c55be0945a6fd5743ca7c68b6e2f6ef82a135bc64e21c85ed53b327a
-  data.tar.gz: ab59f14656af75386669744314147a0ce4805a803b3a64a4b3d8d06e6a0add59be3f3dc39e0df471cbb7b13b4f8d1826562ec54e7409e768109a94a4407d146c
+  metadata.gz: 5db803a6ca78402d935b9916fb4ab8996bc7e1e7507cf5f768978155b1e51fff84356f7a775749766d70475c18d668414f66679d44822763a3a0a3f628e8d09e
+  data.tar.gz: de218538bf247fe54e6beea9aeee31b3479b18dfc3729f58a7a9c828c93f395a2ecfe8df446c69692bac14a6e850ecafaeae7ca4549afbe9c27351443896462c

data/.rubocop.yml

@@ -1,16 +1,22 @@
 Style/Documentation:
   Enabled: false
+
 Style/StringLiterals:
   EnforcedStyle: double_quotes
+
 Style/AlignHash:
   EnforcedHashRocketStyle: table
   EnforcedColonStyle: table
+
 Metrics/ClassLength:
     Max: 120
+
 Metrics/LineLength:
   Max: 120
+
 Metrics/AbcSize:
   Max: 18
+
 AllCops:
   TargetRubyVersion: 2.3
   DisplayCopNames: true
@@ -19,3 +25,4 @@ AllCops:
     - 'spec/**/*'
     - 'test/**/*'
     - 'vendor/**/*'
+    - 'bin/**/*'

data/Dockerfile

@@ -0,0 +1,10 @@
+FROM ruby:2.3.4
+
+ENV APP_HOME oneaccess-rb
+ENV PATH=$APP_HOME/bin:$PATH
+
+RUN gem install bundler
+ENV BUNDLE_JOBS=4
+
+ADD . $APP_HOME
+WORKDIR $APP_HOME

data/README.md

@@ -40,6 +40,7 @@ Not all the methods in the API are currently supported, here's a list of all sup
 - Organization's Product Groups: _/entitlement/organization/productgroup/getList_
 - Organization: _/organizations/id_
 - User's Product Groups: _/entitlement/user/productgroup/getList_
+- User Entitlement Requests: _/entitlement/research/userRequests/getListWithEntitlementsStatus_
 
 ### User by Email _(/user/getByEmail)_
 Official Documentation: http://apidocs.oneaccess.io/docs/usergetorcreate
@@ -155,7 +156,7 @@ resp.data.addresses #=> Array of instances of ONEAccess::DataObject::Address
 
 ### Research Entitlement
 
-### Create an Research Entitlement request
+### Create a Research Entitlement request
 
 Official documentation: http://apidocs.oneaccess.io/docs/entitlmentresearchuserrequestscreate
 
@@ -172,3 +173,19 @@ rescue ONEAccess::Error::APIError => e
   puts "Error creating the Research Entitlement Request: #{e}"
 end
 ```
+
+### User Entitlement Requests _(/entitlement/research/userRequests/getListWithEntitlementsStatus)_
+Official Documentation: http://apidocs.oneaccess.io/docs/entitlementresearchuserrequests
+
+This method returns a list of user entitlement requests based on the specified `UserIds`, `PageNumber`, `PageSize`, `SortBy`, `IsAscending`, `CreateDateFrom`, `CreateDateTo`, `SellSideOrgIds` and `EntitlementStatus` parameter values.
+
+#### How to use:
+```ruby
+begin
+  resp = ONEAccess::API::Entitlement::Research::UserRequests.get_list
+
+  resp.data #=> Array of instances of ONEAcess::DataObject::UserEntitlementRequest
+rescue ONEAccess::Error::APIError => e
+  puts "Error listing the available user entitlement requests"
+end
+```

data/bin/bundle

@@ -0,0 +1,105 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'bundle' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "rubygems"
+
+m = Module.new do
+    module_function
+
+  def invoked_as_script?
+    File.expand_path($0) == File.expand_path(__FILE__)
+  end
+
+  def env_var_version
+    ENV["BUNDLER_VERSION"]
+  end
+
+  def cli_arg_version
+    return unless invoked_as_script? # don't want to hijack other binstubs
+    return unless "update".start_with?(ARGV.first || " ") # must be running `bundle update`
+    bundler_version = nil
+    update_index = nil
+    ARGV.each_with_index do |a, i|
+      if update_index && update_index.succ == i && a =~ Gem::Version::ANCHORED_VERSION_PATTERN
+        bundler_version = a
+      end
+      next unless a =~ /\A--bundler(?:[= ](#{Gem::Version::VERSION_PATTERN}))?\z/
+      bundler_version = $1 || ">= 0.a"
+      update_index = i
+    end
+    bundler_version
+  end
+
+  def gemfile
+    gemfile = ENV["BUNDLE_GEMFILE"]
+    return gemfile if gemfile && !gemfile.empty?
+
+    File.expand_path("../../Gemfile", __FILE__)
+  end
+
+  def lockfile
+    lockfile =
+      case File.basename(gemfile)
+      when "gems.rb" then gemfile.sub(/\.rb$/, gemfile)
+      else "#{gemfile}.lock"
+      end
+    File.expand_path(lockfile)
+  end
+
+  def lockfile_version
+    return unless File.file?(lockfile)
+    lockfile_contents = File.read(lockfile)
+    return unless lockfile_contents =~ /\n\nBUNDLED WITH\n\s{2,}(#{Gem::Version::VERSION_PATTERN})\n/
+    Regexp.last_match(1)
+  end
+
+  def bundler_version
+    @bundler_version ||= begin
+      env_var_version || cli_arg_version ||
+        lockfile_version || "#{Gem::Requirement.default}.a"
+    end
+  end
+
+  def load_bundler!
+    ENV["BUNDLE_GEMFILE"] ||= gemfile
+
+    # must dup string for RG < 1.8 compatibility
+    activate_bundler(bundler_version.dup)
+  end
+
+  def activate_bundler(bundler_version)
+    if Gem::Version.correct?(bundler_version) && Gem::Version.new(bundler_version).release < Gem::Version.new("2.0")
+      bundler_version = "< 2"
+    end
+    gem_error = activation_error_handling do
+      gem "bundler", bundler_version
+    end
+    return if gem_error.nil?
+    require_error = activation_error_handling do
+      require "bundler/version"
+    end
+    return if require_error.nil? && Gem::Requirement.new(bundler_version).satisfied_by?(Gem::Version.new(Bundler::VERSION))
+    warn "Activating bundler (#{bundler_version}) failed:\n#{gem_error.message}\n\nTo install the version of bundler this project requires, run `gem install bundler -v '#{bundler_version}'`"
+    exit 42
+  end
+
+  def activation_error_handling
+    yield
+    nil
+  rescue StandardError, LoadError => e
+    e
+  end
+end
+
+m.load_bundler!
+
+if m.invoked_as_script?
+  load Gem.bin_path("bundler", "bundle")
+end

data/bin/rspec

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+load(bundle_binstub) if File.file?(bundle_binstub)
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/bin/rubocop

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+load(bundle_binstub) if File.file?(bundle_binstub)
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rubocop", "rubocop")

data/docker-compose.yml

@@ -0,0 +1,12 @@
+version: '3'
+
+services:
+  test:
+    build: .
+    command: bash -c 'rubocop && rspec'
+    volumes:
+      - .:/oneaccess-rb
+      - bundler-cache:/usr/local/bundle
+
+volumes:
+  bundler-cache:

data/lib/oneaccess.rb

@@ -8,6 +8,7 @@ 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/api/base"
 require_relative "./oneaccess/api/user"

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "../../../response/user_requests_response"
+require_relative "../../../response/user_entitlement_requests_response"
 
 module ONEAccess
   module API
@@ -19,8 +20,37 @@ module ONEAccess
                                    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

data/lib/oneaccess/data_object/organization_light.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative "./representer/organization_light"
 
 module ONEAccess

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module ONEAccess
   module DataObject
     module Representer

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module ONEAccess
+  module DataObject
+    module Representer
+      class SellSideUserGroupEntitlement < Representable::Decorator
+        include Representable::JSON
+
+        property :id, as: :Id, type: Integer
+        property :name, as: :Name, type: String
+        property :is_approved, as: :IsApproved
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative "../user_light"
+require_relative "../organization_light"
+require_relative "../sell_side_user_group_entitlement"
+
+module ONEAccess
+  module DataObject
+    module Representer
+      class UserEntitlementRequest < Representable::Decorator
+        include Representable::JSON
+
+        property :id, as: :Id, type: Integer
+        property :create_date, as: :CreateDate, parse_filter: ->(value, _) { Time.parse(value) }
+        property :update_date, as: :UpdateDate, parse_filter: ->(value, _) { Time.parse(value) }
+        property :notes, as: :Notes, type: String
+        property :status, as: :Status, type: Integer
+        property :user, as: :User,
+          decorator: Representer::UserLight, class: DataObject::UserLight
+        property :buy_side_org, as: :BuySideOrg,
+          decorator: Representer::OrganizationLight, class: DataObject::OrganizationLight
+        property :sell_side_org, as: :SellSideOrg,
+          decorator: Representer::OrganizationLight, class: DataObject::OrganizationLight
+        collection :sell_side_user_groups, as: :SellSideUserGroups,
+          decorator: Representer::SellSideUserGroupEntitlement, class: DataObject::SellSideUserGroupEntitlement
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module ONEAccess
+  module DataObject
+    module Representer
+      class UserLight < Representable::Decorator
+        include Representable::JSON
+
+        property :id, as: :Id, type: Integer
+        property :first_name, as: :FirstName, type: String
+        property :last_name, as: :LastName, type: String
+        property :email, as: :Email, type: String
+      end
+    end
+  end
+end

data/lib/oneaccess/data_object/sell_side_user_group_entitlement.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative "./representer/sell_side_user_group_entitlement"
+
+module ONEAccess
+  module DataObject
+    class SellSideUserGroupEntitlement
+      extend Serializable
+
+      represented_by Representer::SellSideUserGroupEntitlement
+
+      attr_accessor :id
+      attr_accessor :name
+      attr_accessor :is_approved
+
+      alias approved? is_approved
+    end
+  end
+end

data/lib/oneaccess/data_object/user_entitlement_request.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative "./representer/user_entitlement_request"
+
+module ONEAccess
+  module DataObject
+    class UserEntitlementRequest
+      extend Serializable
+
+      represented_by Representer::UserEntitlementRequest
+
+      attr_accessor :id
+      attr_accessor :create_date
+      attr_accessor :update_date
+      attr_accessor :notes
+      attr_accessor :status
+      attr_accessor :user
+      attr_accessor :buy_side_org
+      attr_accessor :sell_side_org
+      attr_accessor :sell_side_user_groups
+
+      def pending?
+        status == EntitlementStatus::NONE
+      end
+
+      def approved?
+        status == EntitlementStatus::APPROVED
+      end
+
+      def rejected?
+        status == EntitlementStatus::REJECTED
+      end
+
+      def provisional?
+        status == EntitlementStatus::PROVISIONAL
+      end
+    end
+  end
+end

data/lib/oneaccess/data_object/user_light.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative "./representer/user_light"
+
+module ONEAccess
+  module DataObject
+    class UserLight
+      extend Serializable
+
+      represented_by Representer::UserLight
+
+      attr_accessor :id
+      attr_accessor :first_name
+      attr_accessor :last_name
+      attr_accessor :email
+    end
+  end
+end

data/lib/oneaccess/enum/entitlement_status.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module ONEAccess
+  module EntitlementStatus
+    NONE = 1
+    APPROVED = 2
+    REJECTED = 3
+    PROVISIONAL = 4
+  end
+end

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative "./paginated_response"
+require_relative "../../data_object/user_entitlement_request"
+
+module ONEAccess
+  module Response
+    module Representer
+      class UserEntitlementRequestsResponse < PaginatedResponse
+        collection :data, as:        :Data,
+                          decorator: DataObject::Representer::UserEntitlementRequest,
+                          class:     DataObject::UserEntitlementRequest
+      end
+    end
+  end
+end

data/lib/oneaccess/response/user_entitlement_requests_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative "./paginated_response"
+require_relative "./representer/user_entitlement_requests_response"
+
+module ONEAccess
+  module Response
+    class UserEntitlementRequestsResponse < PaginatedResponse
+      represented_by Representer::UserEntitlementRequestsResponse
+    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.7"
-  s.date          = "2018-01-08"
+  s.version       = "0.1.8"
+  s.date          = "2018-01-10"
   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.7
+  version: 0.1.8
 platform: ruby
 authors:
 - Alex Correia Santos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-08 00:00:00.000000000 Z
+date: 2018-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -174,12 +174,17 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- Dockerfile
 - Gemfile
 - Gemfile.lock
 - README.md
 - Rakefile
+- bin/bundle
+- bin/rspec
+- bin/rubocop
 - circle.yml
 - console
+- docker-compose.yml
 - lib/oneaccess.rb
 - lib/oneaccess/api/base.rb
 - lib/oneaccess/api/entitlement/organization/product_group.rb
@@ -215,11 +220,18 @@ files:
 - lib/oneaccess/data_object/representer/region.rb
 - lib/oneaccess/data_object/representer/research_document_info.rb
 - lib/oneaccess/data_object/representer/saml_info.rb
+- lib/oneaccess/data_object/representer/sell_side_user_group_entitlement.rb
 - lib/oneaccess/data_object/representer/user.rb
+- lib/oneaccess/data_object/representer/user_entitlement_request.rb
+- lib/oneaccess/data_object/representer/user_light.rb
 - lib/oneaccess/data_object/research_document_info.rb
 - lib/oneaccess/data_object/saml_info.rb
+- lib/oneaccess/data_object/sell_side_user_group_entitlement.rb
 - lib/oneaccess/data_object/user.rb
+- lib/oneaccess/data_object/user_entitlement_request.rb
+- lib/oneaccess/data_object/user_light.rb
 - lib/oneaccess/enum/api_status_code.rb
+- lib/oneaccess/enum/entitlement_status.rb
 - lib/oneaccess/enum/product_group_status.rb
 - lib/oneaccess/enum/product_type.rb
 - lib/oneaccess/error/api_error.rb
@@ -242,9 +254,11 @@ 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/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/user_entitlement_requests_response.rb
 - lib/oneaccess/response/user_requests_response.rb
 - lib/oneaccess/response/user_response.rb
 - lib/oneaccess/serializable.rb