oneaccess 0.4.5 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8a04af112ed6e47d0c4f118cd95d356f7342a1c1
-  data.tar.gz: e89480e74840ed6d2649f7c85f41906a25834244
+  metadata.gz: bebd929f809465f9ab5a529dc6ac4192016f59c5
+  data.tar.gz: 129cc7733676fc2e395ee8b55d6e9c1609d60b5f
 SHA512:
-  metadata.gz: dc82b3f2c18cabaa72cef280fd79cea24b60d463c9ac0fa5ea1ace1a16e2b4c92c2cd747223fa2dd8ba6349c9595a43398aee754858083852aeab77661e32204
-  data.tar.gz: 15750546f7085327cc303bdbe8a5897c6ee9c138d87cb0626136dde89a85628fbc362f4e0534087f6d4ae17d338218ade674b26b02ef60b9fc941c9c80df4fa3
+  metadata.gz: a7917796d561f384e34cdf4b62c17da2e651ba856563dff9983d6ad055b1bad485dd0e5999f6d69e3caf0bb0f6dfbf40af2b2defaf63e5960bc5dcc85416c8d2
+  data.tar.gz: bb5f64a8d3834ce5d74f2a5cfad290a5d8341180889b994329fda2d9e2182b32eab101fa34313d7d9500f4344e72f093986d43285f3b1cef454764691c6703a1

data/.rubocop.yml

@@ -20,6 +20,10 @@ Metrics/LineLength:
 Metrics/AbcSize:
   Max: 18
 
+Metrics/ParameterLists:
+  Max: 5
+  CountKeywordArgs: false
+
 AllCops:
   TargetRubyVersion: 2.3
   DisplayCopNames: true

data/README.md

@@ -261,3 +261,17 @@ rescue ONEAccess::Error::APIError => e
   puts "Error creating the inducement"
 end
 ```
+
+### Get Providers Users Details _(/providers/GetProviderUserDetails)_
+
+Reference endpoint to get providers users details information.
+
+#### How to use:
+```ruby
+begin
+  resp = ONEAccess::API::V3_0::Providers.users_details(buy_side_org_id: 1, provider_id: 1, contract_status_id: 1, user_id: 1, user_email: 'hello@example.com', user_reverse_entitlement_status: 1, vendor_id: 1, reverse_entitlement_status: 1)
+  resp #=> instance of Array containing ONEAccess::DataObject::ProvidersUsersDetails
+rescue ONEAccess::Error::APIError => e
+  puts "Error getting providers users details"
+end
+```

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

@@ -25,7 +25,7 @@ module ONEAccess
               Response::UserRequestsResponse.from_json(response.body)
             end
 
-            def self.get_list( # rubocop:disable Metrics/ParameterLists, Metrics/MethodLength
+            def self.get_list( # rubocop:disable Metrics/MethodLength
               user_ids: [],
               page_number: 0,
               page_size: 20,

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "../../response/inducement_response"
+require_relative "../../response/providers_users_details_response"
 
 module ONEAccess
   module API
@@ -22,6 +23,52 @@ module ONEAccess
 
             Response::InducementResponse.from_json(resp.body)
           end
+
+          def users_details( # rubocop:disable Metrics/MethodLength
+            buy_side_org_id:,
+            provider_id:,
+            contract_status_id: nil,
+            user_id: nil,
+            user_email: nil,
+            user_reverse_entitlement_status: nil,
+            vendor_id: nil,
+            reverse_entitlement_status: nil
+          )
+
+            provider_id = comma_separated_values(provider_id)
+
+            params = {
+              buysideorgid:                 buy_side_org_id,
+              contractstatusid:             contract_status_id,
+              userid:                       user_id,
+              useremail:                    user_email,
+              userreverseentitlementstatus: user_reverse_entitlement_status,
+              vendorid:                     vendor_id,
+              reverseentitlementstatus:     reverse_entitlement_status
+            }.reject { |_, value| value.nil? }
+
+            resp = send_get("GetProviderUserDetails?providerid=#{provider_id}", params)
+
+            Response::ProvidersUsersDetailsResponse.from_json(resp.body)
+          end
+
+          private
+
+          # We need to diffently handle comma separated values since the RestClient,
+          # gem URI encode the commas and this is not supported by the API.
+          #
+          # Examples:
+          # [1,2$,3] => '1,2%24,3'
+          # '1,2$,3' => '1,2%24,3'
+          def comma_separated_values(values)
+            values = values.split(",") if values.is_a?(String)
+            if values.is_a?(Array)
+              values = values.map do |value|
+                URI.encode_www_form_component(value)
+              end.join(",")
+            end
+            values
+          end
         end
       end
     end

data/lib/oneaccess/data_object/providers_user_details.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative "./representer/providers_user_details"
+
+module ONEAccess
+  module DataObject
+    class ProvidersUserDetails
+      extend Serializable
+
+      represented_by Representer::ProvidersUserDetails
+
+      attr_accessor :id
+      attr_accessor :user_rev_ent_status
+      attr_accessor :first_name
+      attr_accessor :last_name
+      attr_accessor :email
+      attr_accessor :vendors_count
+      attr_accessor :vendors
+    end
+  end
+end

data/lib/oneaccess/data_object/providers_user_details_vendor.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative "./representer/providers_user_details_vendor"
+
+module ONEAccess
+  module DataObject
+    class ProvidersUserDetailsVendor
+      extend Serializable
+
+      represented_by Representer::ProvidersUserDetailsVendor
+
+      attr_accessor :id
+      attr_accessor :rev_ent_status
+      attr_accessor :name
+      attr_accessor :short_name
+      attr_accessor :ent_level
+    end
+  end
+end

data/lib/oneaccess/data_object/providers_users_details.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative "./representer/providers_users_details"
+
+module ONEAccess
+  module DataObject
+    class ProvidersUsersDetails
+      extend Serializable
+
+      represented_by Representer::ProvidersUsersDetails
+
+      attr_accessor :provider_id
+      attr_accessor :buy_side_org_id
+      attr_accessor :provider_name
+      attr_accessor :contract_status
+      attr_accessor :contract_status_id
+      attr_accessor :buy_side_org_name
+      attr_accessor :users_count
+      attr_accessor :users
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative "../providers_user_details_vendor"
+
+module ONEAccess
+  module DataObject
+    module Representer
+      class ProvidersUserDetails < Representable::Decorator
+        include Representable::JSON
+
+        property :id, type: Integer
+        property :user_rev_ent_status, as: :userreventstatus, type: String
+        property :first_name, as: :firstname, type: String
+        property :last_name, as: :lastname, type: String
+        property :email, type: String
+        property :vendors_count, as: :vendorscount, type: Integer
+        collection :vendors, decorator: Representer::ProvidersUserDetailsVendor,
+                             class:     DataObject::ProvidersUserDetailsVendor
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module ONEAccess
+  module DataObject
+    module Representer
+      class ProvidersUserDetailsVendor < Representable::Decorator
+        include Representable::JSON
+
+        property :id, type: Integer
+        property :rev_ent_status, as: :reventstatus, type: String
+        property :name, type: String
+        property :short_name, as: :shortname, type: String
+        property :ent_level, as: :entlevel, type: String
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative "../providers_user_details"
+
+module ONEAccess
+  module DataObject
+    module Representer
+      class ProvidersUsersDetails < Representable::Decorator
+        include Representable::JSON
+
+        property :provider_id, as: :providerid, type: Integer
+        property :buy_side_org_id, as: :buysideorgid, type: Integer
+        property :provider_name, as: :providername, type: String
+        property :contract_status, as: :contractstatus, type: String
+        property :contract_status_id, as: :contractstatusid, type: String
+        property :buy_side_org_name, as: :buysideorgname, type: String
+        property :users_count, as: :userscount, type: Integer
+        collection :users, decorator: Representer::ProvidersUserDetails,
+                           class:     DataObject::ProvidersUserDetails
+      end
+    end
+  end
+end

data/lib/oneaccess/response/collection_response.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module ONEAccess
+  module Response
+    class CollectionResponse
+      extend Serializable
+
+      class << self
+        private
+
+        def collection?
+          true
+        end
+      end
+    end
+  end
+end

data/lib/oneaccess/response/providers_users_details_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative "./collection_response"
+require_relative "./representer/providers_users_details_response"
+
+module ONEAccess
+  module Response
+    class ProvidersUsersDetailsResponse < CollectionResponse
+      represented_by Representer::ProvidersUsersDetailsResponse
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module ONEAccess
+  module Response
+    module Representer
+      class CollectionResponse < Representable::Decorator
+        include Representable::JSON::Collection
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative "./collection_response"
+require_relative "../../data_object/providers_users_details"
+
+module ONEAccess
+  module Response
+    module Representer
+      class ProvidersUsersDetailsResponse < CollectionResponse
+        items decorator: DataObject::Representer::ProvidersUsersDetails,
+              class:     DataObject::ProvidersUsersDetails
+      end
+    end
+  end
+end

data/lib/oneaccess/serializable.rb

@@ -7,9 +7,21 @@ module ONEAccess
     end
 
     def from_json(json)
-      obj = new
-      @representer_class.new(obj).from_json(json)
-      obj
+      if collection?
+        collection = []
+        @representer_class.new(collection).from_json(json)
+        collection
+      else
+        obj = new
+        @representer_class.new(obj).from_json(json)
+        obj
+      end
+    end
+
+    private
+
+    def collection?
+      false
     end
   end
 end

data/oneaccess.gemspec

@@ -2,8 +2,8 @@
 
 Gem::Specification.new do |s|
   s.name          = "oneaccess"
-  s.version       = "0.4.5"
-  s.date          = "2018-03-17"
+  s.version       = "0.5.0"
+  s.date          = "2018-04-18"
   s.summary       = "ONEAccess API wrapper"
   s.description   = "Easily communicate with ONEAccess API"
   s.homepage      = "https://github.com/AlphaExchange/oneaccess-rb"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oneaccess
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.5.0
 platform: ruby
 authors:
 - Alex Correia Santos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-17 00:00:00.000000000 Z
+date: 2018-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -215,6 +215,9 @@ files:
 - lib/oneaccess/data_object/organization.rb
 - lib/oneaccess/data_object/organization_light.rb
 - lib/oneaccess/data_object/product_group.rb
+- lib/oneaccess/data_object/providers_user_details.rb
+- lib/oneaccess/data_object/providers_user_details_vendor.rb
+- lib/oneaccess/data_object/providers_users_details.rb
 - lib/oneaccess/data_object/region.rb
 - lib/oneaccess/data_object/representer/address.rb
 - lib/oneaccess/data_object/representer/city.rb
@@ -230,6 +233,9 @@ files:
 - lib/oneaccess/data_object/representer/organization.rb
 - lib/oneaccess/data_object/representer/organization_light.rb
 - lib/oneaccess/data_object/representer/product_group.rb
+- lib/oneaccess/data_object/representer/providers_user_details.rb
+- lib/oneaccess/data_object/representer/providers_user_details_vendor.rb
+- lib/oneaccess/data_object/representer/providers_users_details.rb
 - lib/oneaccess/data_object/representer/region.rb
 - lib/oneaccess/data_object/representer/research_document_info.rb
 - lib/oneaccess/data_object/representer/saml_info.rb
@@ -254,6 +260,7 @@ files:
 - lib/oneaccess/response/api_error.rb
 - lib/oneaccess/response/base_response.rb
 - lib/oneaccess/response/changed_users_response.rb
+- lib/oneaccess/response/collection_response.rb
 - lib/oneaccess/response/companies_response.rb
 - lib/oneaccess/response/company_response.rb
 - lib/oneaccess/response/contributors_response.rb
@@ -264,9 +271,11 @@ files:
 - lib/oneaccess/response/organization_response.rb
 - lib/oneaccess/response/paginated_response.rb
 - lib/oneaccess/response/product_groups_response.rb
+- lib/oneaccess/response/providers_users_details_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/collection_response.rb
 - lib/oneaccess/response/representer/companies_response.rb
 - lib/oneaccess/response/representer/company_response.rb
 - lib/oneaccess/response/representer/contributors_response.rb
@@ -277,6 +286,7 @@ files:
 - lib/oneaccess/response/representer/organization_response.rb
 - lib/oneaccess/response/representer/paginated_response.rb
 - lib/oneaccess/response/representer/product_groups_response.rb
+- lib/oneaccess/response/representer/providers_users_details_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