oneaccess 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a4da0375fca05ed2c1fad532b8f93db78dabd41e
-  data.tar.gz: bca80f5344d83c88969a2378403c7408a6d2d3aa
+  metadata.gz: e7ae1428a99e8896caba2a79ad34a7593a2ce156
+  data.tar.gz: 81b2d2137a1461398794b72f51afc682502a3a4b
 SHA512:
-  metadata.gz: fcc9482c9322264571ac5eb56d47de07bbf698fb460fcd5355a08dc79140b4f13259a949a56e53d48c1e33f8cd9423212b95cb18d76cd41ef39d26b55db976d3
-  data.tar.gz: a91d3031db34bc0f27037f6248786d5998d04c7caba221c843dfe577c793e9bdf3af68d4368286c8ed95c9df6395bd680c978503330ffbd592ab9ff87078f416
+  metadata.gz: c9e78607b5a269a5fae9be54dc1d01aa5e9abf4d444c85f2e3ea7b582be37d96cfd5db0989239a05d0c3236cb3f7d7be26ba90cea3b8ceabdde8b52212fb4e1c
+  data.tar.gz: 1769369a86740bba393a98ad1d04812c7828565cb62bebbc4f2702df127b43754910bb54e28b1d14f7e816241c81b8cd9c3b1255cba47a010056793f6bbb1612

data/README.md

@@ -104,6 +104,36 @@ rescue ONEAccess::Error::APIError => e
 end
 ```
 
+### Symbology Companies _(/symbology/companies)_
+Official Documentation: http://apidocs.oneaccess.io/docs/symbologycompanies
+
+This method retrieves a list of symbology companies by providing a `IsPrivate`, `PageNumber` and `PageSize`.
+
+#### How to use:
+```ruby
+resp = ONEAccess::API::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
+
+end
+```
+
+### Symbology Company _(/symbology/company/:id)_
+Official Documentation: http://apidocs.oneaccess.io/docs/referencescountriesid
+
+This method retrieves a company by providing an `Id`.
+
+#### How to use:
+```ruby
+resp = ONEAccess::API::Symbology.company(id: 1)
+
+resp #=> instance of ONEAcess::Response::CompanyResponse
+resp.data #=> instance of Array containing ONEAcess::DataObject::Company
+
+end
+```
+
 ### Get Organization by ID _(/organizations/id)_
 Official Documentation: http://apidocs.oneaccess.io/docs/organization-2
 

data/lib/oneaccess.rb

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

data/lib/oneaccess/api/symbology.rb

@@ -0,0 +1,26 @@
+# 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/data_object/company.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative "./representer/company"
+
+module ONEAccess
+  module DataObject
+    class Company
+      attr_accessor :id
+      attr_accessor :name
+      attr_accessor :is_private
+      attr_accessor :exchange_code
+      attr_accessor :ticker
+      attr_accessor :website
+      attr_accessor :address
+      attr_accessor :sub_industry
+      attr_accessor :perm_id
+
+      alias is_private? is_private
+      alias private? is_private
+    end
+  end
+end

data/lib/oneaccess/data_object/company_light.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative "./representer/company_light"
+
+module ONEAccess
+  module DataObject
+    class CompanyLight
+      attr_accessor :id
+      attr_accessor :name
+      attr_accessor :is_private
+      attr_accessor :exchange_code
+      attr_accessor :ticker
+
+      alias is_private? is_private
+      alias private? is_private
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module ONEAccess
+  module DataObject
+    module Representer
+      class Company < Representable::Decorator
+        include Representable::JSON
+
+        property :id, as: :Id, type: Integer
+        property :perm_id, as: :PermId, type: Integer
+        property :name, as: :Name, type: String
+        property :is_private, as: :IsPrivate
+        property :exchange_code, as: :ExchangeCode, type: String
+        property :ticker, as: :Ticker, type: String
+        property :website, as: :Website, type: String
+        property :address, as: :Address,
+          decorator: Representer::Address, class: DataObject::Address
+        property :sub_industry, as: :SubIndustry,
+          decorator: Representer::SubIndustry, class: DataObject::SubIndustry
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module ONEAccess
+  module DataObject
+    module Representer
+      class CompanyLight < Representable::Decorator
+        include Representable::JSON
+
+        property :id, as: :Id, type: Integer
+        property :name, as: :Name, type: String
+        property :is_private, as: :IsPrivate
+        property :exchange_code, as: :ExchangeCode, type: String
+        property :ticker, as: :Ticker, type: String
+      end
+    end
+  end
+end

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

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

data/lib/oneaccess/data_object/sub_industry.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative "./representer/sub_industry"
+
+module ONEAccess
+  module DataObject
+    class SubIndustry
+      attr_accessor :id
+      attr_accessor :name
+      attr_accessor :code
+    end
+  end
+end

data/lib/oneaccess/response/companies_response.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative "./representer/companies_representer"
+
+module ONEAccess
+  module Response
+    class CompaniesResponse
+      extend Serializable
+
+      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

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

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+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
+        collection :data, as:        :Data,
+                          decorator: DataObject::Representer::CompanyLight,
+                          class:     DataObject::CompanyLight
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative "../../data_object/sub_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
+        property :data, as:        :Data,
+                        decorator: DataObject::Representer::Company,
+                        class:     DataObject::Company
+      end
+    end
+  end
+end

data/oneaccess.gemspec

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 Gem::Specification.new do |s|
   s.name          = "oneaccess"
-  s.version       = "0.1.1"
+  s.version       = "0.1.2"
   s.date          = "2017-11-29"
   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.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Alex Correia Santos
@@ -186,10 +186,13 @@ files:
 - lib/oneaccess/api/entitlement/user/product_group.rb
 - lib/oneaccess/api/organizations.rb
 - lib/oneaccess/api/research.rb
+- lib/oneaccess/api/symbology.rb
 - lib/oneaccess/api/user.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/country.rb
 - lib/oneaccess/data_object/global_region.rb
 - lib/oneaccess/data_object/organization.rb
@@ -198,6 +201,8 @@ files:
 - lib/oneaccess/data_object/region.rb
 - lib/oneaccess/data_object/representer/address.rb
 - 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/country.rb
 - lib/oneaccess/data_object/representer/global_region.rb
 - lib/oneaccess/data_object/representer/organization.rb
@@ -206,18 +211,24 @@ 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/sub_industry.rb
 - lib/oneaccess/data_object/representer/user.rb
 - lib/oneaccess/data_object/research_document_info.rb
 - lib/oneaccess/data_object/saml_info.rb
+- lib/oneaccess/data_object/sub_industry.rb
 - lib/oneaccess/data_object/user.rb
 - lib/oneaccess/enum/api_status_code.rb
 - lib/oneaccess/enum/product_group_status.rb
 - lib/oneaccess/enum/product_type.rb
 - lib/oneaccess/error/api_error.rb
 - lib/oneaccess/response/api_error.rb
+- lib/oneaccess/response/companies_response.rb
+- lib/oneaccess/response/company_response.rb
 - lib/oneaccess/response/organizations_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/product_groups_response.rb
 - lib/oneaccess/response/representer/research_document_response.rb