oneaccess 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 30dd9ac3513fca2659dc828b8c4a85d2f54aa629
-  data.tar.gz: ab06c8eb41a0e7de85f8821fbe152d40ba96633a
+  metadata.gz: a4da0375fca05ed2c1fad532b8f93db78dabd41e
+  data.tar.gz: bca80f5344d83c88969a2378403c7408a6d2d3aa
 SHA512:
-  metadata.gz: ea9db92248596b40291813288865189fa8a500f9febcbc1fde81d301c77981d1d7066d8ed7078bd0da5f6818c768df177dca292fd19a6d1885c5a8e3f44c6af7
-  data.tar.gz: 237723faf8bafff4e210b7d2a01f1e1f13f4c20310db148b954e574ca1734263d22cda2e1375ebd91f6c07c2cfbbca895b2342a40167488d1092899d86feb63c
+  metadata.gz: fcc9482c9322264571ac5eb56d47de07bbf698fb460fcd5355a08dc79140b4f13259a949a56e53d48c1e33f8cd9423212b95cb18d76cd41ef39d26b55db976d3
+  data.tar.gz: a91d3031db34bc0f27037f6248786d5998d04c7caba221c843dfe577c793e9bdf3af68d4368286c8ed95c9df6395bd680c978503330ffbd592ab9ff87078f416

data/README.md

@@ -38,6 +38,7 @@ Not all the methods in the API are currently supported, here's a list of all sup
 - Research Document: _/research/document_
 - Research Document by User ID: _/research/documentByUserId_
 - Organization's Product Groups: _/entitlement/organization/productgroup/getList_
+- Organization: _/organizations/id_
 - User's Product Groups: _/entitlement/user/productgroup/getList_
 
 ### User by Email _(/user/getByEmail)_
@@ -103,3 +104,21 @@ rescue ONEAccess::Error::APIError => e
 end
 ```
 
+### Get Organization by ID _(/organizations/id)_
+Official Documentation: http://apidocs.oneaccess.io/docs/organization-2
+
+This method returns an Organization by providing the Organization ID.
+
+#### How to use:
+```ruby
+resp = ONEAccess::API::Organizations.get_organization(id: 123)
+
+resp.data #=> instance of ONEAcess::DataObject::Organization
+resp.data.id #=> id of the Organization
+resp.data.name #=> name of the Organization
+resp.data.short_name #=> Short Name of the Organization
+resp.data.active #=> Boolean meaning if the Organization is Active or not
+resp.data.type #=> type of the Organization (Unspecified = 0, Buyside = 1, Sellside = 2, Advisory = 3, Other = 4, Vendor = 5, Internal = 6)
+resp.data.main_address #=> instance of ONEAccess::DataObject::Address
+resp.data.addresses #=> Array of instances of ONEAccess::DataObject::Address
+```

data/lib/oneaccess.rb

@@ -11,6 +11,7 @@ require_relative "./oneaccess/enum/product_group_status"
 require_relative "./oneaccess/api/base"
 require_relative "./oneaccess/api/user"
 require_relative "./oneaccess/api/research"
+require_relative "./oneaccess/api/organizations"
 require_relative "./oneaccess/api/entitlement/organization/product_group"
 require_relative "./oneaccess/api/entitlement/user/product_group"
 

data/lib/oneaccess/api/base.rb

@@ -8,7 +8,7 @@ module ONEAccess
   module API
     class Base
       class << self
-        def get(method, params = {})
+        def send_get(method, params = {})
           RestClient.get(api_url(method), { params: params }.merge(auth_headers))
         rescue RestClient::Exception => e
           raise create_api_error(e)

data/lib/oneaccess/api/entitlement/organization/product_group.rb

@@ -9,7 +9,7 @@ module ONEAccess
           api_path "/entitlement/organization/productgroup"
 
           def self.get_list(contributor_org_id:, page_number: 0, page_size: 20, type: nil)
-            resp = get("getList", Query: {
+            resp = send_get("getList", Query: {
               PageNumber:       page_number,
               PageSize:         page_size,
               ContributorOrgId: contributor_org_id,

data/lib/oneaccess/api/entitlement/user/product_group.rb

@@ -9,7 +9,7 @@ module ONEAccess
           api_path "/entitlement/user/productgroup"
 
           def self.get_list(user_id:, page_number: 0, page_size: 20, type: nil)
-            resp = get("getList", Query: {
+            resp = send_get("getList", Query: {
               PageNumber: page_number,
               PageSize:   page_size,
               UserId:     user_id,

data/lib/oneaccess/api/organizations.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative "../response/organizations_response"
+
+module ONEAccess
+  module API
+    class Organizations < Base
+      api_path "/organizations"
+
+      def self.get(id:)
+        resp = send_get("get/#{id}")
+        Response::OrganizationsResponse.from_json(resp.body)
+      end
+    end
+  end
+end

data/lib/oneaccess/api/research.rb

@@ -7,13 +7,13 @@ module ONEAccess
       api_path "/research"
 
       def self.document(document_id:, first_name:, last_name:, email:)
-        resp = get("document", documentId: document_id, userFirstName: first_name,
+        resp = send_get("document", documentId: document_id, userFirstName: first_name,
           userLastName: last_name, userEmail: email)
         Response::ResearchDocumentResponse.from_json(resp.body)
       end
 
       def self.document_by_user_id(document_id:, user_id:)
-        resp = get("documentByUserId", documentId: document_id, userId: user_id)
+        resp = send_get("documentByUserId", documentId: document_id, userId: user_id)
         Response::ResearchDocumentResponse.from_json(resp.body)
       end
     end

data/lib/oneaccess/api/user.rb

@@ -7,7 +7,7 @@ module ONEAccess
       api_path "/user"
 
       def self.get_by_email(first_name:, last_name:, email:)
-        resp = get("getbyemail", userFirstName: first_name, userLastName: last_name, userEmail: email)
+        resp = send_get("getbyemail", userFirstName: first_name, userLastName: last_name, userEmail: email)
         Response::UserResponse.from_json(resp.body)
       end
     end

data/lib/oneaccess/data_object/organization.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+require_relative "./representer/organization"
+
+module ONEAccess
+  module DataObject
+    class Organization
+      attr_accessor :id
+      attr_accessor :name
+      attr_accessor :active
+      attr_accessor :short_name
+      attr_accessor :type
+      attr_accessor :addresses
+      attr_accessor :main_address
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module ONEAccess
+  module DataObject
+    module Representer
+      class Organization < Representable::Decorator
+        include Representable::JSON
+
+        property :id, as: :Id, type: Integer
+        property :name, as: :Name, type: String
+        property :active, as: :Active
+        property :short_name, as: :ShortName, type: String
+        property :type, as: :Type, type: Integer
+        property :main_address, as: :MainAddress, decorator: Representer::Address, class: DataObject::Address
+        collection :addresses, as: :Addresses, decorator: Representer::Address, class: DataObject::Address
+      end
+    end
+  end
+end

data/lib/oneaccess/response/organizations_response.rb

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

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative "../../data_object/organization"
+
+module ONEAccess
+  module Response
+    module Representer
+      class OrganizationsResponse < Representable::Decorator
+        include Representable::JSON
+
+        property :api_status_code, as: :ApiStatusCode
+        property :data, as: :Data, decorator: DataObject::Representer::Organization, class: DataObject::Organization
+      end
+    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.0"
-  s.date          = "2017-11-01"
+  s.version       = "0.1.1"
+  s.date          = "2017-11-29"
   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.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Alex Correia Santos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-01 00:00:00.000000000 Z
+date: 2017-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -184,6 +184,7 @@ files:
 - lib/oneaccess/api/base.rb
 - lib/oneaccess/api/entitlement/organization/product_group.rb
 - lib/oneaccess/api/entitlement/user/product_group.rb
+- lib/oneaccess/api/organizations.rb
 - lib/oneaccess/api/research.rb
 - lib/oneaccess/api/user.rb
 - lib/oneaccess/configuration.rb
@@ -191,6 +192,7 @@ files:
 - lib/oneaccess/data_object/city.rb
 - lib/oneaccess/data_object/country.rb
 - lib/oneaccess/data_object/global_region.rb
+- lib/oneaccess/data_object/organization.rb
 - lib/oneaccess/data_object/organization_light.rb
 - lib/oneaccess/data_object/product_group.rb
 - lib/oneaccess/data_object/region.rb
@@ -198,6 +200,7 @@ files:
 - lib/oneaccess/data_object/representer/city.rb
 - lib/oneaccess/data_object/representer/country.rb
 - lib/oneaccess/data_object/representer/global_region.rb
+- 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/region.rb
@@ -212,8 +215,10 @@ files:
 - lib/oneaccess/enum/product_type.rb
 - lib/oneaccess/error/api_error.rb
 - lib/oneaccess/response/api_error.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/organizations_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