oneaccess 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7be4f855aec4b0bd8540d94fae6068e4c691d725
-  data.tar.gz: 2d7de3e913bfcd0915706a18180feb581f776ccc
+  metadata.gz: 1b3213f560c414b929e43bca013e0eec25d99219
+  data.tar.gz: 0d8b39ab276eeffa5c94b6230ce6705a63ced999
 SHA512:
-  metadata.gz: bdc66efc284b1cdfe8f3b9456cc0ed263c4dca9e3d1332c98c1915d762f90c248fa56ee4218e770c370b468d74daeddbcd3958c9ff0bade43faf11dc3555f444
-  data.tar.gz: 0802f43c609e2e50126c07e61ebec9e05bec18bb9ef807c8a98ed6861bbd5b6a5b4c3c78a8785e968e65cc16c573ec4fc895c3bc841b0506c7140f4390cfebb0
+  metadata.gz: 10c3a85a0d6d80325b6326b07b34bc3a4a7b9b2235a925117bc3bc50e89723b7ae31c727aab357e2b7144faf332d8ca69014528e25ef3b0f95dfb973e261362f
+  data.tar.gz: a799f9ce81142ec26b1341d38caf89a01c461523fe7e52fb9fc38a9f2f2e7574bbc728682bed25f3506691252898a05157648351a480987c723fc0beaf723ea6

data/lib/oneaccess/api/organizations.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "../response/organizations_response"
+require_relative "../response/organization_response"
 
 module ONEAccess
   module API
@@ -9,7 +9,7 @@ module ONEAccess
 
       def self.get(id:)
         resp = send_get("get/#{id}")
-        Response::OrganizationsResponse.from_json(resp.body)
+        Response::OrganizationResponse.from_json(resp.body)
       end
     end
   end

data/lib/oneaccess/api/references.rb

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

data/lib/oneaccess/data_object/address.rb

@@ -4,6 +4,10 @@ require_relative "./representer/address"
 module ONEAccess
   module DataObject
     class Address
+      extend Serializable
+
+      represented_by Representer::Address
+
       attr_accessor :id
       attr_accessor :city
       attr_accessor :country

data/lib/oneaccess/data_object/city.rb

@@ -4,6 +4,10 @@ require_relative "./representer/city"
 module ONEAccess
   module DataObject
     class City
+      extend Serializable
+
+      represented_by Representer::City
+
       attr_accessor :id
       attr_accessor :name
       attr_accessor :code

data/lib/oneaccess/data_object/company.rb

@@ -5,6 +5,10 @@ require_relative "./representer/company"
 module ONEAccess
   module DataObject
     class Company
+      extend Serializable
+
+      represented_by Representer::Company
+
       attr_accessor :id
       attr_accessor :name
       attr_accessor :is_private

data/lib/oneaccess/data_object/company_light.rb

@@ -5,6 +5,10 @@ require_relative "./representer/company_light"
 module ONEAccess
   module DataObject
     class CompanyLight
+      extend Serializable
+
+      represented_by Representer::CompanyLight
+
       attr_accessor :id
       attr_accessor :name
       attr_accessor :is_private

data/lib/oneaccess/data_object/country.rb

@@ -4,6 +4,10 @@ require_relative "./representer/country"
 module ONEAccess
   module DataObject
     class Country
+      extend Serializable
+
+      represented_by Representer::Country
+
       attr_accessor :id
       attr_accessor :name
       attr_accessor :code

data/lib/oneaccess/data_object/global_region.rb

@@ -4,6 +4,10 @@ require_relative "./representer/global_region"
 module ONEAccess
   module DataObject
     class GlobalRegion
+      extend Serializable
+
+      represented_by Representer::GlobalRegion
+
       attr_accessor :id
       attr_accessor :name
       attr_accessor :code

data/lib/oneaccess/data_object/industry.rb

@@ -5,9 +5,14 @@ require_relative "./representer/industry"
 module ONEAccess
   module DataObject
     class Industry
+      extend Serializable
+
+      represented_by Representer::Industry
+
       attr_accessor :id
       attr_accessor :name
       attr_accessor :code
+      attr_accessor :parent
     end
   end
 end

data/lib/oneaccess/data_object/organization.rb

@@ -4,6 +4,10 @@ require_relative "./representer/organization"
 module ONEAccess
   module DataObject
     class Organization
+      extend Serializable
+
+      represented_by Representer::Organization
+
       attr_accessor :id
       attr_accessor :name
       attr_accessor :active

data/lib/oneaccess/data_object/organization_light.rb

@@ -4,6 +4,10 @@ require_relative "./representer/organization_light"
 module ONEAccess
   module DataObject
     class OrganizationLight
+      extend Serializable
+
+      represented_by Representer::OrganizationLight
+
       attr_accessor :id
       attr_accessor :name
     end

data/lib/oneaccess/data_object/product_group.rb

@@ -4,6 +4,10 @@ require_relative "./representer/product_group"
 module ONEAccess
   module DataObject
     class ProductGroup
+      extend Serializable
+
+      represented_by Representer::ProductGroup
+
       attr_accessor :id
       attr_accessor :name
       attr_accessor :description

data/lib/oneaccess/data_object/region.rb

@@ -4,6 +4,10 @@ require_relative "./representer/region"
 module ONEAccess
   module DataObject
     class Region
+      extend Serializable
+
+      represented_by Representer::Region
+
       attr_accessor :id
       attr_accessor :name
       attr_accessor :code

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

@@ -1,4 +1,11 @@
 # frozen_string_literal: true
+require_relative "../industry"
+
+# declare industry to avoid circular dependency
+# rubocop:disable Style/ClassAndModuleChildren
+class ONEAccess::DataObject::Industry; end
+class ONEAccess::DataObject::Representer::Industry < Representable::Decorator; end
+# rubocop:enable Style/ClassAndModuleChildren
 
 module ONEAccess
   module DataObject
@@ -9,6 +16,8 @@ module ONEAccess
         property :id, as: :Id, type: Integer
         property :name, as: :Name, type: String
         property :code, as: :Code, type: String
+        property :parent, as: :Parent,
+          decorator: Representer::Industry, class: DataObject::Industry
       end
     end
   end

data/lib/oneaccess/data_object/research_document_info.rb

@@ -4,6 +4,10 @@ require_relative "./representer/research_document_info"
 module ONEAccess
   module DataObject
     class ResearchDocumentInfo
+      extend Serializable
+
+      represented_by Representer::ResearchDocumentInfo
+
       attr_accessor :url
       attr_accessor :title
       attr_accessor :saml # instance of SAMLInfo

data/lib/oneaccess/data_object/saml_info.rb

@@ -4,6 +4,10 @@ require_relative "./representer/saml_info"
 module ONEAccess
   module DataObject
     class SAMLInfo
+      extend Serializable
+
+      represented_by Representer::SAMLInfo
+
       attr_accessor :saml_response
       attr_accessor :sso_login_url
       attr_accessor :use_iframe

data/lib/oneaccess/data_object/user.rb

@@ -4,6 +4,10 @@ require_relative "./representer/user"
 module ONEAccess
   module DataObject
     class User
+      extend Serializable
+
+      represented_by Representer::User
+
       attr_accessor :id
       attr_accessor :first_name
       attr_accessor :last_name

data/lib/oneaccess/response/base_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module ONEAccess
+  module Response
+    class BaseResponse
+      extend Serializable
+
+      attr_accessor :api_status_code
+      attr_accessor :data
+    end
+  end
+end

data/lib/oneaccess/response/companies_response.rb

@@ -1,21 +1,12 @@
 # frozen_string_literal: true
 
-require_relative "./representer/companies_representer"
+require_relative "./paginated_response"
+require_relative "./representer/companies_response"
 
 module ONEAccess
   module Response
-    class CompaniesResponse
-      extend Serializable
-
+    class CompaniesResponse < PaginatedResponse
       represented_by Representer::CompaniesResponse
-
-      attr_accessor :api_status_code
-      attr_accessor :total_count
-      attr_accessor :has_more_records
-      attr_accessor :data
-
-      alias has_more_records? has_more_records
-      alias more_records? has_more_records
     end
   end
 end

data/lib/oneaccess/response/company_response.rb

@@ -1,16 +1,12 @@
 # frozen_string_literal: true
 
-require_relative "./representer/company_representer"
+require_relative "./base_response"
+require_relative "./representer/company_response"
 
 module ONEAccess
   module Response
-    class CompanyResponse
-      extend Serializable
-
-      represented_by Representer::CompanyRepresenter
-
-      attr_accessor :api_status_code
-      attr_accessor :data
+    class CompanyResponse < BaseResponse
+      represented_by Representer::CompanyResponse
     end
   end
 end

data/lib/oneaccess/response/industries_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative "./paginated_response"
+require_relative "./representer/industries_response"
+
+module ONEAccess
+  module Response
+    class IndustriesResponse < PaginatedResponse
+      represented_by Representer::IndustriesResponse
+    end
+  end
+end

data/lib/oneaccess/response/{organizations_response.rb → organization_response.rb}

@@ -1,13 +1,12 @@
 # frozen_string_literal: true
-
-require_relative "./representer/organizations_response"
+require_relative "./representer/organization_response"
 
 module ONEAccess
   module Response
-    class OrganizationsResponse
+    class OrganizationResponse
       extend Serializable
 
-      represented_by Representer::OrganizationsResponse
+      represented_by Representer::OrganizationResponse
 
       attr_accessor :api_status_code
       attr_accessor :data

data/lib/oneaccess/response/paginated_response.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative "./base_response"
+
+module ONEAccess
+  module Response
+    class PaginatedResponse < BaseResponse
+      attr_accessor :total_count
+      attr_accessor :has_more_records
+
+      alias has_more_records? has_more_records
+      alias more_records? has_more_records
+    end
+  end
+end

data/lib/oneaccess/response/product_groups_response.rb

@@ -1,20 +1,12 @@
 # frozen_string_literal: true
+
+require_relative "./paginated_response"
 require_relative "./representer/product_groups_response"
 
 module ONEAccess
   module Response
-    class ProductGroupsResponse
-      extend Serializable
-
+    class ProductGroupsResponse < PaginatedResponse
       represented_by Representer::ProductGroupsResponse
-
-      attr_accessor :api_status_code
-      attr_accessor :total_count
-      attr_accessor :has_more_records
-      attr_accessor :data
-
-      alias has_more_records? has_more_records
-      alias more_records? has_more_records
     end
   end
 end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module ONEAccess
+  module Response
+    module Representer
+      class BaseResponse < Representable::Decorator
+        include Representable::JSON
+
+        property :api_status_code, as: :ApiStatusCode
+      end
+    end
+  end
+end

data/lib/oneaccess/response/representer/{companies_representer.rb → companies_response.rb}

@@ -1,16 +1,12 @@
 # frozen_string_literal: true
 
+require_relative "./paginated_response"
 require_relative "../../data_object/company_light"
 
 module ONEAccess
   module Response
     module Representer
-      class CompaniesResponse < Representable::Decorator
-        include Representable::JSON
-
-        property :api_status_code, as: :ApiStatusCode
-        property :has_more_records, as: :HasMoreRecords
-        property :total_count, as: :TotalCount
+      class CompaniesResponse < PaginatedResponse
         collection :data, as:        :Data,
                           decorator: DataObject::Representer::CompanyLight,
                           class:     DataObject::CompanyLight

data/lib/oneaccess/response/representer/{company_representer.rb → company_response.rb}

@@ -1,15 +1,13 @@
 # frozen_string_literal: true
 
+require_relative "./base_response"
 require_relative "../../data_object/industry"
 require_relative "../../data_object/company"
 
 module ONEAccess
   module Response
     module Representer
-      class CompanyRepresenter < Representable::Decorator
-        include Representable::JSON
-
-        property :api_status_code, as: :ApiStatusCode
+      class CompanyResponse < BaseResponse
         property :data, as:        :Data,
                         decorator: DataObject::Representer::Company,
                         class:     DataObject::Company

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

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

data/lib/oneaccess/response/representer/{organizations_response.rb → organization_response.rb}

@@ -1,14 +1,12 @@
 # frozen_string_literal: true
 
+require_relative "./base_response"
 require_relative "../../data_object/organization"
 
 module ONEAccess
   module Response
     module Representer
-      class OrganizationsResponse < Representable::Decorator
-        include Representable::JSON
-
-        property :api_status_code, as: :ApiStatusCode
+      class OrganizationResponse < BaseResponse
         property :data, as: :Data, decorator: DataObject::Representer::Organization, class: DataObject::Organization
       end
     end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative "./base_response"
+
+module ONEAccess
+  module Response
+    module Representer
+      class PaginatedResponse < BaseResponse
+        property :has_more_records, as: :HasMoreRecords
+        property :total_count, as: :TotalCount
+      end
+    end
+  end
+end

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

@@ -1,16 +1,12 @@
 # frozen_string_literal: true
+
+require_relative "./paginated_response"
 require_relative "../../data_object/product_group"
 
 module ONEAccess
   module Response
     module Representer
-      class ProductGroupsResponse < Representable::Decorator
-        include Representable::JSON
-
-        property :api_status_code, as: :ApiStatusCode
-        property :has_more_records, as: :HasMoreRecords
-        property :total_count, as: :TotalCount
-        property :api_status_code, as: :ApiStatusCode
+      class ProductGroupsResponse < PaginatedResponse
         collection :data, as:        :Data,
                           decorator: DataObject::Representer::ProductGroup,
                           class:     DataObject::ProductGroup

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

@@ -1,13 +1,12 @@
 # frozen_string_literal: true
+
+require_relative "./base_response"
 require_relative "../../data_object/research_document_info"
 
 module ONEAccess
   module Response
     module Representer
-      class ResearchDocumentResponse < Representable::Decorator
-        include Representable::JSON
-
-        property :api_status_code, as: :ApiStatusCode
+      class ResearchDocumentResponse < BaseResponse
         property :data, as:        :Data,
                         decorator: DataObject::Representer::ResearchDocumentInfo,
                         class:     DataObject::ResearchDocumentInfo

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

@@ -1,13 +1,12 @@
 # frozen_string_literal: true
+
+require_relative "./base_response"
 require_relative "../../data_object/user"
 
 module ONEAccess
   module Response
     module Representer
-      class UserResponse < Representable::Decorator
-        include Representable::JSON
-
-        property :api_status_code, as: :ApiStatusCode
+      class UserResponse < BaseResponse
         property :data, as: :Data, decorator: DataObject::Representer::User, class: DataObject::User
       end
     end

data/lib/oneaccess/response/research_document_response.rb

@@ -1,15 +1,12 @@
 # frozen_string_literal: true
+
+require_relative "./base_response"
 require_relative "./representer/research_document_response"
 
 module ONEAccess
   module Response
-    class ResearchDocumentResponse
-      extend Serializable
-
+    class ResearchDocumentResponse < BaseResponse
       represented_by Representer::ResearchDocumentResponse
-
-      attr_accessor :api_status_code
-      attr_accessor :data
     end
   end
 end

data/lib/oneaccess/response/user_response.rb

@@ -1,15 +1,12 @@
 # frozen_string_literal: true
+
+require_relative "./base_response"
 require_relative "./representer/user_response"
 
 module ONEAccess
   module Response
-    class UserResponse
-      extend Serializable
-
+    class UserResponse < BaseResponse
       represented_by Representer::UserResponse
-
-      attr_accessor :api_status_code
-      attr_accessor :data
     end
   end
 end

data/lib/oneaccess.rb

@@ -13,6 +13,7 @@ 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/organization/product_group"
 require_relative "./oneaccess/api/entitlement/user/product_group"
 

data/oneaccess.gemspec

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 Gem::Specification.new do |s|
   s.name          = "oneaccess"
-  s.version       = "0.1.3"
+  s.version       = "0.1.4"
   s.date          = "2017-12-05"
   s.summary       = "ONEAccess API wrapper"
   s.description   = "Easily communicate with ONEAccess API"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oneaccess
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Alex Correia Santos
@@ -185,6 +185,7 @@ files:
 - lib/oneaccess/api/entitlement/organization/product_group.rb
 - lib/oneaccess/api/entitlement/user/product_group.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
@@ -222,14 +223,20 @@ files:
 - lib/oneaccess/enum/product_type.rb
 - lib/oneaccess/error/api_error.rb
 - lib/oneaccess/response/api_error.rb
+- lib/oneaccess/response/base_response.rb
 - lib/oneaccess/response/companies_response.rb
 - lib/oneaccess/response/company_response.rb
-- lib/oneaccess/response/organizations_response.rb
+- lib/oneaccess/response/industries_response.rb
+- lib/oneaccess/response/organization_response.rb
+- lib/oneaccess/response/paginated_response.rb
 - lib/oneaccess/response/product_groups_response.rb
 - lib/oneaccess/response/representer/api_error.rb
-- lib/oneaccess/response/representer/companies_representer.rb
-- lib/oneaccess/response/representer/company_representer.rb
-- lib/oneaccess/response/representer/organizations_response.rb
+- lib/oneaccess/response/representer/base_response.rb
+- lib/oneaccess/response/representer/companies_response.rb
+- lib/oneaccess/response/representer/company_response.rb
+- lib/oneaccess/response/representer/industries_response.rb
+- 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/research_document_response.rb
 - lib/oneaccess/response/representer/user_response.rb