oneaccess 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cae42a24d0cf2773ecb31820ad2eeae1efbf383c
-  data.tar.gz: 244900a83db61df3a04873f4f54170633f292631
+  metadata.gz: 30dd9ac3513fca2659dc828b8c4a85d2f54aa629
+  data.tar.gz: ab06c8eb41a0e7de85f8821fbe152d40ba96633a
 SHA512:
-  metadata.gz: ef2dc321b38d61f87fe4ac586b9916239a720c828afb6a3bf6f49db55118ba88e1f666c2fd03113dc9ed388669f88151f8aecd17b67497feb579343613783f53
-  data.tar.gz: fe7df37936bfe7e51c969d54f4f0fd10af29cc7f0cae08a3ddcc94bdd92d825a1e23263fe179d855e202a186d00e21ee670b11e90e9c1a07f16e752243006ba8
+  metadata.gz: ea9db92248596b40291813288865189fa8a500f9febcbc1fde81d301c77981d1d7066d8ed7078bd0da5f6818c768df177dca292fd19a6d1885c5a8e3f44c6af7
+  data.tar.gz: 237723faf8bafff4e210b7d2a01f1e1f13f4c20310db148b954e574ca1734263d22cda2e1375ebd91f6c07c2cfbbca895b2342a40167488d1092899d86feb63c

data/.gitignore

@@ -0,0 +1,4 @@
+.byebug_history
+*.gem
+*.bak
+coverage

data/.rspec

@@ -0,0 +1,2 @@
+--require spec_helper
+--format documentation

data/.rubocop.yml

@@ -0,0 +1,21 @@
+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
+  DisplayStyleGuide: true
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'vendor/**/*'

data/Gemfile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,105 @@
+PATH
+  remote: .
+  specs:
+    oneaccess (0.0.0)
+      multi_json (~> 1.12.0)
+      representable (~> 3.0.4)
+      rest-client (~> 2.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.1)
+      public_suffix (~> 2.0, >= 2.0.2)
+    ansi (1.5.0)
+    ast (2.3.0)
+    byebug (9.1.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    declarative (0.0.10)
+    declarative-option (0.1.0)
+    diff-lcs (1.3)
+    docile (1.1.5)
+    domain_name (0.5.20170404)
+      unf (>= 0.0.5, < 1.0.0)
+    hashdiff (0.3.5)
+    hirb (0.7.3)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    json (2.1.0)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    multi_json (1.12.1)
+    netrc (0.11.0)
+    parser (2.4.0.0)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    public_suffix (2.0.5)
+    rainbow (2.2.2)
+      rake
+    rake (11.3.0)
+    representable (3.0.4)
+      declarative (< 0.1.0)
+      declarative-option (< 0.2.0)
+      uber (< 0.2.0)
+    rest-client (2.0.2)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+    rubocop (0.45.0)
+      parser (>= 2.3.1.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
+    safe_yaml (1.0.4)
+    simplecov (0.15.1)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-console (0.4.2)
+      ansi
+      hirb
+      simplecov
+    simplecov-html (0.10.2)
+    uber (0.1.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.4)
+    unicode-display_width (1.3.0)
+    webmock (3.0.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.12)
+  byebug
+  oneaccess!
+  rake (~> 11.3)
+  rspec (~> 3.6)
+  rubocop (~> 0.45.0)
+  simplecov
+  simplecov-console
+  webmock (~> 3.0.1)
+
+BUNDLED WITH
+   1.15.3

data/README.md

@@ -0,0 +1,105 @@
+# ONEAccess for Ruby
+This is a ruby gem that wraps the ONEAccess API in an easy to use ruby library, so the API can be accesses transparently by invoking methods.
+
+The full documentation about the ONEAccess API can be found at:
+http://apidocs.oneaccess.io/docs
+
+Currently, only the version `v1.1` is supported by this gem.
+
+## Installation & Setup
+Install the gem directly:
+```
+gem install oneaccess
+```
+
+or add it to your `Gemfile`:
+```
+gem 'oneaccess'
+```
+
+The gem must be initialized with the API keys. If it's being used in a Rails project, then the file `/config/initializers/oneaccess.rb` should be created:
+```ruby
+ONEAccess.configure do |config|
+  config.api_key = 'API_KEY_HERE'
+  config.master_api_key = 'MASTER_API_KEY_HERE'
+end
+```
+
+## Tests
+The tests are written in RSpec. Run the `rspec` in the root directory of the project.
+A coverage report is automatically generated and stored under `/coverage`.
+
+## Documentation
+The API and data model has been converted into ruby modules and classes following the same organization as defined in the OA documentation, but adapted to the ruby convetions (underscored instead of camelCase). Therefore, by reading the official documentation you can easily infer what the ruby API will look like.
+
+Not all the methods in the API are currently supported, here's a list of all suported calls:
+
+- User by Email: _/user/getByEmail_
+- Research Document: _/research/document_
+- Research Document by User ID: _/research/documentByUserId_
+- Organization's Product Groups: _/entitlement/organization/productgroup/getList_
+- User's Product Groups: _/entitlement/user/productgroup/getList_
+
+### User by Email _(/user/getByEmail)_
+Official Documentation: http://apidocs.oneaccess.io/docs/usergetorcreate
+
+This method returns a `User` object if it matches the first name, last name, and email. If there's not a match, then a new user is created and returned.
+
+#### How to use:
+```ruby
+resp = ONEAccess::API::User.getByEmail(first_name: 'Alex', last_name: 'Santos', email: 'alex@ae.com')
+
+resp.data #=> instance of ONEAcess::DataObject::User
+resp.data.id #=> 305 (id of the user)
+resp.data.organization.id #=> 805 (id of the company)
+resp.data.email #=> alex@ae.com
+```
+
+### Research Document _(/research/document)_
+Official Documentation: http://apidocs.oneaccess.io/docs/researchdocument
+
+This method retrieves a research document by providing the research ID and the first name, last name, and email of the user requesting access. If the user does not have access to the research, a `ONEAccess::Error:APIError` exception will be raisen.
+
+#### How to use:
+```ruby
+begin
+  resp = ONEAccess::API::Research.document(document_id: 2341, first_name: 'Alex', last_name: 'Santos', email: 'alex@ae.com')
+
+  resp.data #=> instance of ONEAcess::DataObject::ResearchDocumentInfo
+  resp.data.url #=> url of the document
+  resp.data.title #=> document's title
+  resp.data.saml #=> instance of ONEAccess::DataObject::SAMLInfo
+
+  puts "requires SAML" unless resp.data.saml.nil?
+
+rescue ONEAccess::Error::APIError => e
+  if e.api_status_code == ONEAccess::APIStatusCode::OBJECT_NOT_FOUND
+    puts "Not entitled or does not exist"
+  end
+end
+```
+
+### Research Document by User ID _(/research/documentByUserId)_
+Official Documentation: http://apidocs.oneaccess.io/docs/researchdocumentbyuserid
+
+Similar to the previous method, this method retrieves a research document by providing the research ID, but together with the user's ID instead. If the user does not have access to the research, a `ONEAccess::Error:APIError` exception will be raisen.
+
+#### How to use:
+```ruby
+begin
+  resp = ONEAccess::API::Research.document_by_user_id(document_id: 2341, user_id: 805)
+
+  resp.data #=> instance of ONEAcess::DataObject::ResearchDocumentInfo
+  resp.data.url #=> url of the document
+  resp.data.title #=> document's title
+  resp.data.saml #=> instance of ONEAccess::DataObject::SAMLInfo
+
+  puts "requires SAML" unless resp.data.saml.nil?
+
+rescue ONEAccess::Error::APIError => e
+  if e.api_status_code == ONEAccess::APIStatusCode::OBJECT_NOT_FOUND
+    puts "Not entitled or does not exist"
+  end
+end
+```
+

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+desc "Run tests"
+
+task default: :test

data/circle.yml

@@ -0,0 +1,9 @@
+machine:
+  ruby:
+    version: 2.3.3
+test:
+  override:
+    - bundle exec rake
+    - bundle exec rspec
+  post:
+    - bundle exec rubocop

data/console

@@ -0,0 +1 @@
+irb -I . -r lib/oneaccess.rb

data/lib/oneaccess/api/base.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+require "rest-client"
+require "json"
+require_relative "../response/api_error"
+require_relative "../error/api_error"
+
+module ONEAccess
+  module API
+    class Base
+      class << self
+        def get(method, params = {})
+          RestClient.get(api_url(method), { params: params }.merge(auth_headers))
+        rescue RestClient::Exception => e
+          raise create_api_error(e)
+        end
+
+        def resource_api_path
+          const_get("RESOURCE_API_PATH")
+        rescue
+          nil
+        end
+
+        def api_url(method = nil)
+          url = "#{Configuration.base_url}#{resource_api_path}"
+          return url if method.nil?
+          "#{url}/#{method}"
+        end
+
+        protected
+
+        def api_path(path)
+          raise "API path has already been set" if resource_api_path
+          self.resource_api_path = path
+        end
+
+        private
+
+        def create_api_error(error)
+          api_error_data = Response::APIError.new
+          Response::Representer::APIError.new(api_error_data).from_json(error.http_body)
+          Error::APIError.new(error.http_code, api_error_data.api_status_code, api_error_data.api_status_message)
+        end
+
+        def resource_api_path=(path)
+          const_set("RESOURCE_API_PATH", path)
+        end
+
+        def auth_headers
+          {
+            "X-One-Access-Api-Key" => Configuration.api_key,
+            "Authorization"        => "X-One-Access-Master-Api-Key #{Configuration.master_api_key}"
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+require_relative "../../../response/product_groups_response"
+
+module ONEAccess
+  module API
+    module Entitlement
+      module Organization
+        class ProductGroup < Base
+          api_path "/entitlement/organization/productgroup"
+
+          def self.get_list(contributor_org_id:, page_number: 0, page_size: 20, type: nil)
+            resp = get("getList", Query: {
+              PageNumber:       page_number,
+              PageSize:         page_size,
+              ContributorOrgId: contributor_org_id,
+              Type:             type
+            }.to_json)
+            Response::ProductGroupsResponse.from_json(resp.body)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+require_relative "../../../response/product_groups_response"
+
+module ONEAccess
+  module API
+    module Entitlement
+      module User
+        class ProductGroup < Base
+          api_path "/entitlement/user/productgroup"
+
+          def self.get_list(user_id:, page_number: 0, page_size: 20, type: nil)
+            resp = get("getList", Query: {
+              PageNumber: page_number,
+              PageSize:   page_size,
+              UserId:     user_id,
+              Type:       type
+            }.to_json)
+            Response::ProductGroupsResponse.from_json(resp.body)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/oneaccess/api/research.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+require_relative "../response/research_document_response"
+
+module ONEAccess
+  module API
+    class Research < Base
+      api_path "/research"
+
+      def self.document(document_id:, first_name:, last_name:, email:)
+        resp = 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)
+        Response::ResearchDocumentResponse.from_json(resp.body)
+      end
+    end
+  end
+end

data/lib/oneaccess/api/user.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+require_relative "../response/user_response"
+
+module ONEAccess
+  module API
+    class User < Base
+      api_path "/user"
+
+      def self.get_by_email(first_name:, last_name:, email:)
+        resp = get("getbyemail", userFirstName: first_name, userLastName: last_name, userEmail: email)
+        Response::UserResponse.from_json(resp.body)
+      end
+    end
+  end
+end

data/lib/oneaccess/configuration.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+module ONEAccess
+  class Configuration
+    DEFAULT_BASE_URL = "http://ws.oneaccess.io/v1.1"
+
+    class << self
+      attr_accessor :base_url
+      attr_accessor :api_key
+      attr_accessor :master_api_key
+    end
+
+    self.base_url = DEFAULT_BASE_URL
+  end
+end

data/lib/oneaccess/data_object/address.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+require_relative "./representer/address"
+
+module ONEAccess
+  module DataObject
+    class Address
+      attr_accessor :id
+      attr_accessor :city
+      attr_accessor :country
+      attr_accessor :region
+      attr_accessor :is_main_address
+
+      alias main_address? is_main_address
+    end
+  end
+end

data/lib/oneaccess/data_object/city.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+require_relative "./representer/city"
+
+module ONEAccess
+  module DataObject
+    class City
+      attr_accessor :id
+      attr_accessor :name
+      attr_accessor :code
+      attr_accessor :description
+      attr_accessor :longitude
+      attr_accessor :latitude
+      attr_accessor :country
+      attr_accessor :region
+    end
+  end
+end

data/lib/oneaccess/data_object/country.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+require_relative "./representer/country"
+
+module ONEAccess
+  module DataObject
+    class Country
+      attr_accessor :id
+      attr_accessor :name
+      attr_accessor :code
+      attr_accessor :code3
+      attr_accessor :description
+      attr_accessor :global_region
+      attr_accessor :regions
+    end
+  end
+end

data/lib/oneaccess/data_object/global_region.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+require_relative "./representer/global_region"
+
+module ONEAccess
+  module DataObject
+    class GlobalRegion
+      attr_accessor :id
+      attr_accessor :name
+      attr_accessor :code
+      attr_accessor :code3
+      attr_accessor :description
+      attr_accessor :global_region
+      attr_accessor :regions
+    end
+  end
+end

data/lib/oneaccess/data_object/organization_light.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+require_relative "./representer/organization_light"
+
+module ONEAccess
+  module DataObject
+    class OrganizationLight
+      attr_accessor :id
+      attr_accessor :name
+    end
+  end
+end

data/lib/oneaccess/data_object/product_group.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+require_relative "./representer/product_group"
+
+module ONEAccess
+  module DataObject
+    class ProductGroup
+      attr_accessor :id
+      attr_accessor :name
+      attr_accessor :description
+      attr_accessor :status
+      attr_accessor :contributor_org_id
+      attr_accessor :type
+      attr_accessor :is_default
+
+      alias is_default? is_default
+      alias default? is_default
+
+      def active?
+        status == ProductGroupStatus::ACTIVE
+      end
+
+      def inactive?
+        status == ProductGroupStatus::INACTIVE
+      end
+
+      def research?
+        type == ProductType::RESEARCH
+      end
+
+      def private_events?
+        type == ProductType::PRIVATE_EVENT
+      end
+
+      def events?
+        type == ProductType::EVENT
+      end
+
+      def models?
+        type == ProductType::MODEL
+      end
+    end
+  end
+end

data/lib/oneaccess/data_object/region.rb

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

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+require_relative "../city"
+require_relative "../country"
+require_relative "../region"
+
+module ONEAccess
+  module DataObject
+    module Representer
+      class Address < Representable::Decorator
+        include Representable::JSON
+
+        property :id, as: :Id, type: Integer
+        property :is_main_address, as: :IsMainAddress
+        property :city, as: :City, decorator: Representer::City, class: DataObject::City
+        property :country, as: :Country, decorator: Representer::Country, class: DataObject::Country
+        property :region, as: :Region, decorator: Representer::Region, class: DataObject::Region
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+require_relative "../country"
+require_relative "../region"
+
+module ONEAccess
+  module DataObject
+    module Representer
+      class City < Representable::Decorator
+        include Representable::JSON
+
+        property :id, as: :Id, type: Integer
+        property :name, as: :Name, type: String
+        property :code, as: :Code, type: String
+        property :description, as: :Description, type: String
+        property :longitude, as: :Longitude, type: Float
+        property :latitude, as: :Type, type: Float
+        property :country, as: :Country, decorator: Representer::Country, class: DataObject::Country
+        property :region, as: :Region, decorator: Representer::Region, class: DataObject::Region
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+require_relative "../region"
+require_relative "../global_region"
+
+module ONEAccess
+  module DataObject
+    module Representer
+      class Country < Representable::Decorator
+        include Representable::JSON
+
+        property :id, as: :Id, type: Integer
+        property :name, as: :Name, type: String
+        property :code, as: :Code, type: String
+        property :code3, as: :Code3, type: String
+        property :description, as: :Description, type: String
+        property :global_region, as: :GlobalRegion,
+          decorator: Representer::GlobalRegion, class: DataObject::GlobalRegion
+        collection :regions, as: :Regions,
+          decorator: Representer::Region, class: DataObject::Region
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+require_relative "../country"
+require_relative "../region"
+
+# declare country to avoid circular dependency
+# rubocop:disable Style/ClassAndModuleChildren
+class ONEAccess::DataObject::Country; end
+class ONEAccess::DataObject::Representer::Country < Representable::Decorator; end
+# rubocop:enable Style/ClassAndModuleChildren
+
+module ONEAccess
+  module DataObject
+    module Representer
+      class GlobalRegion < Representable::Decorator
+        include Representable::JSON
+
+        property :id, as: :Id, type: Integer
+        property :name, as: :Name, type: String
+        property :code, as: :Code, type: String
+        property :description, as: :Description, type: String
+        collection :countries, as: :Countries, decorator: Representer::Country, class: DataObject::Country
+        collection :regions, as: :Regions, decorator: Representer::Region, class: DataObject::Region
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+module ONEAccess
+  module DataObject
+    module Representer
+      class ProductGroup < Representable::Decorator
+        include Representable::JSON
+
+        property :id, as: :Id, type: Integer
+        property :name, as: :Name, type: String
+        property :description, as: :Description, type: String
+        property :status, as: :Status, type: Integer
+        property :contributor_org_id, as: :ContributorOrgId, type: Integer
+        property :type, as: :Type, type: Integer
+        property :is_default, as: :IsDefault
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+require_relative "../saml_info"
+
+module ONEAccess
+  module DataObject
+    module Representer
+      class ResearchDocumentInfo < Representable::Decorator
+        include Representable::JSON
+
+        property :url, as: :Url, type: String
+        property :title, as: :Title, type: String
+        property :saml, as: :SAML,
+          decorator: Representer::SAMLInfo, class: DataObject::SAMLInfo
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+module ONEAccess
+  module DataObject
+    module Representer
+      class SAMLInfo < Representable::Decorator
+        include Representable::JSON
+
+        property :saml_response, as: :SAMLResponse, type: String
+        property :sso_login_url, as: :SSOLoginUrl, type: String
+        property :use_iframe, as: :UseIframe
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+require_relative "../organization_light"
+require_relative "../address"
+
+module ONEAccess
+  module DataObject
+    module Representer
+      class User < 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
+        property :phone, as: :Phone, type: String
+        property :type, as: :Type, type: Integer
+        property :active, as: :Active
+        property :organization, as: :Organization,
+          decorator: Representer::OrganizationLight, class: DataObject::OrganizationLight
+        property :address, as: :Address,
+           decorator: Representer::Address, class: DataObject::Address
+      end
+    end
+  end
+end

data/lib/oneaccess/data_object/research_document_info.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+require_relative "./representer/research_document_info"
+
+module ONEAccess
+  module DataObject
+    class ResearchDocumentInfo
+      attr_accessor :url
+      attr_accessor :title
+      attr_accessor :saml # instance of SAMLInfo
+    end
+  end
+end

data/lib/oneaccess/data_object/saml_info.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+require_relative "./representer/saml_info"
+
+module ONEAccess
+  module DataObject
+    class SAMLInfo
+      attr_accessor :saml_response
+      attr_accessor :sso_login_url
+      attr_accessor :use_iframe
+
+      alias use_iframe? use_iframe
+    end
+  end
+end

data/lib/oneaccess/data_object/user.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+require_relative "./representer/user"
+
+module ONEAccess
+  module DataObject
+    class User
+      attr_accessor :id
+      attr_accessor :first_name
+      attr_accessor :last_name
+      attr_accessor :email
+      attr_accessor :phone
+      attr_accessor :type
+      attr_accessor :active
+      attr_accessor :reg_status
+      attr_accessor :is_broker_administrator
+      attr_accessor :organization # Instance of OrganizationLight
+      attr_accessor :address
+    end
+  end
+end

data/lib/oneaccess/enum/api_status_code.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+module ONEAccess
+  module APIStatusCode
+    SUCCESS = 0
+    OBJECT_NOT_FOUND = 2
+    BAD_PARAMETER_VALUE = 4
+    ACCESS_DENIED = 7
+    API_KEY_MISSED = 8
+    API_KEY_INVALID = 9
+    AUTHENTICATION_FAILED = 10
+  end
+end

data/lib/oneaccess/enum/product_group_status.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+module ONEAccess
+  module ProductGroupStatus
+    ACTIVE = 1
+    INACTIVE = 2
+  end
+end

data/lib/oneaccess/enum/product_type.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+module ONEAccess
+  module ProductType
+    EVENT = 1
+    PRIVATE_EVENT = 2
+    RESEARCH = 3
+    MODEL = 4
+  end
+end

data/lib/oneaccess/error/api_error.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+module ONEAccess
+  module Error
+    class APIError < StandardError
+      attr_reader :http_status_code
+      attr_reader :api_status_code
+      attr_reader :api_status_message
+
+      def initialize(http_status_code, api_status_code, api_status_message)
+        @http_status_code   = http_status_code
+        @api_status_code    = api_status_code
+        @api_status_message = api_status_message
+        super(api_status_message)
+      end
+    end
+  end
+end

data/lib/oneaccess/response/api_error.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+require_relative "./representer/api_error"
+
+module ONEAccess
+  module Response
+    class APIError
+      attr_accessor :api_status_code
+      attr_accessor :api_status_message
+    end
+  end
+end

data/lib/oneaccess/response/product_groups_response.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+require_relative "./representer/product_groups_response"
+
+module ONEAccess
+  module Response
+    class ProductGroupsResponse
+      extend Serializable
+
+      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/api_error.rb

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

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

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

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

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

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

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

data/lib/oneaccess/response/research_document_response.rb

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

data/lib/oneaccess/response/user_response.rb

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

data/lib/oneaccess/serializable.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+module ONEAccess
+  module Serializable
+    def represented_by(representer_class)
+      @representer_class = representer_class
+    end
+
+    def from_json(json)
+      obj = new
+      @representer_class.new(obj).from_json(json)
+      obj
+    end
+  end
+end

data/lib/oneaccess.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+require "representable"
+
+require_relative "./oneaccess/configuration"
+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/api/base"
+require_relative "./oneaccess/api/user"
+require_relative "./oneaccess/api/research"
+require_relative "./oneaccess/api/entitlement/organization/product_group"
+require_relative "./oneaccess/api/entitlement/user/product_group"
+
+module ONEAccess
+  def self.configure
+    raise "expected block for configuration" unless block_given?
+    yield Configuration
+  end
+end

data/oneaccess.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+Gem::Specification.new do |s|
+  s.name          = "oneaccess"
+  s.version       = "0.1.0"
+  s.date          = "2017-11-01"
+  s.summary       = "ONEAccess API wrapper"
+  s.description   = "Easily communicate with ONEAccess API"
+  s.homepage      = "https://github.com/AlphaExchange/rixml"
+  s.authors       = ["Alex Correia Santos"]
+  s.email         = ["alex@alpha-exchange.com"]
+  s.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  s.require_paths = ["lib"]
+  s.license       = "MIT"
+
+  s.required_ruby_version = ">= 2.2.2"
+
+  s.add_development_dependency "bundler", "~> 1.12"
+  s.add_development_dependency "rspec", "~> 3.6"
+  s.add_development_dependency "rake", "~> 11.3"
+  s.add_development_dependency "rubocop", "~> 0.45.0"
+  s.add_development_dependency "webmock", "~> 3.0.1"
+  s.add_development_dependency "simplecov"
+  s.add_development_dependency "simplecov-console"
+  s.add_development_dependency "byebug"
+
+  s.add_runtime_dependency "representable", "~> 3.0.4"
+  s.add_runtime_dependency "rest-client", "~> 2.0.0"
+  s.add_runtime_dependency "multi_json", "~> 1.12.0"
+end

data/release

@@ -0,0 +1,9 @@
+#!/bin/bash
+cp oneaccess.gemspec oneaccess.gemspec.backup
+sed -i.bak s/0.0.0/$1/g oneaccess.gemspec
+sed -i.bak s/2001-01-01/`date +%Y-%m-%d`/g oneaccess.gemspec
+gem build oneaccess.gemspec
+mv oneaccess.gemspec.backup oneaccess.gemspec
+gem push oneaccess-$1.gem
+git tag -a v$1 -m "Release v$1"
+git push origin --tags

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oneaccess
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Alex Correia Santos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-27 00:00:00.000000000 Z
+date: 2017-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -170,8 +170,59 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
-homepage: https://github.com/AlphaExchange/oneaccess-rb
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- circle.yml
+- console
+- lib/oneaccess.rb
+- lib/oneaccess/api/base.rb
+- lib/oneaccess/api/entitlement/organization/product_group.rb
+- lib/oneaccess/api/entitlement/user/product_group.rb
+- lib/oneaccess/api/research.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/country.rb
+- lib/oneaccess/data_object/global_region.rb
+- lib/oneaccess/data_object/organization_light.rb
+- lib/oneaccess/data_object/product_group.rb
+- 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/country.rb
+- lib/oneaccess/data_object/representer/global_region.rb
+- lib/oneaccess/data_object/representer/organization_light.rb
+- lib/oneaccess/data_object/representer/product_group.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
+- 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/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/product_groups_response.rb
+- lib/oneaccess/response/representer/api_error.rb
+- lib/oneaccess/response/representer/product_groups_response.rb
+- lib/oneaccess/response/representer/research_document_response.rb
+- lib/oneaccess/response/representer/user_response.rb
+- lib/oneaccess/response/research_document_response.rb
+- lib/oneaccess/response/user_response.rb
+- lib/oneaccess/serializable.rb
+- oneaccess.gemspec
+- release
+homepage: https://github.com/AlphaExchange/rixml
 licenses:
 - MIT
 metadata: {}