oneaccess 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 839afdde8249236a6efc2785eea68230f972507b
-  data.tar.gz: c178bab91d1fa090d03220d14c0370a26191e72f
+  metadata.gz: f9bf8a4f7ec45050532078a73f815abc1a2649f3
+  data.tar.gz: d5906200a77db100de8d206d1ac1c6872c70ce52
 SHA512:
-  metadata.gz: 740bfae1d5e4545efba40f1a9406ac0451de90bb272ed2dc3c3d3bd2ff9581d744b5126503f953fcc445fddf4d4a4fcf051c87c2e3469ee9df0aa79d1ebc909b
-  data.tar.gz: 23a0a0f6e43fa55e59ce5dc30b4ef81b389a3070ae28a3b98c020710a7a7013f3656f15dbe9288cde3e1ca3d238ae83912852c2cfe07ab115bc27bbc9d4c985c
+  metadata.gz: adfb7fab327abaeee14fa4dd54851319abae5f79a17da4c7125b7d28e1e2cdf1ca203a7e326f4fb87821654a7ddbbe2ef9b91b9b3f41045f3a7254e447a5f6ac
+  data.tar.gz: c831f84f10a65d5b7624631c6e470a607c05ef67b83f854bb177efe84368dcfc4493a8e12114bec8a2b2d865643b439958fcb311b459ebdcd26c15609d40f688

data/.rubocop.yml

@@ -12,18 +12,18 @@ Layout/AlignHash:
   EnforcedColonStyle: table
 
 Metrics/ClassLength:
-    Max: 120
-
-Metrics/LineLength:
   Max: 120
 
 Metrics/AbcSize:
   Max: 18
 
 Metrics/ParameterLists:
-  Max: 5
+  Max: 7
   CountKeywordArgs: false
 
+Metrics/LineLength:
+  Max: 120
+
 AllCops:
   TargetRubyVersion: 2.4
   DisplayCopNames: true

data/Gemfile.lock

@@ -47,6 +47,9 @@ GEM
     rspec-expectations (3.7.0)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.7.0)
+    rspec-its (1.2.0)
+      rspec-core (>= 3.0.0)
+      rspec-expectations (>= 3.0.0)
     rspec-mocks (3.7.0)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.7.0)
@@ -85,10 +88,11 @@ DEPENDENCIES
   oneaccess!
   rake (~> 11.3)
   rspec (~> 3.6)
+  rspec-its (~> 1.2)
   rubocop (~> 0.55.0)
   simplecov
   simplecov-console
   webmock (~> 3.0.1)
 
 BUNDLED WITH
-   1.16.1
+   1.16.2

data/README.md

@@ -275,3 +275,28 @@ rescue ONEAccess::Error::APIError => e
   puts "Error getting providers users details"
 end
 ```
+
+### Create Buy Side Interaction _(/interactions/BuySideInteractions)_
+
+Reference endpoint to get providers users details information.
+
+Use UTC time zone for start_date and end_date parameter.
+
+#### How to use:
+```ruby
+begin
+  resp = ONEAccess::API::V3_0::Interactions.buy_side_interactions(
+    type: ONEAccess::API::V3_0::Interactions::Types::RESEARCH_READERSHIP,
+    start_date: "2019-05-30 08:00",
+    end_date: "2019-05-30 08:30",
+    user_id: "3264",
+    broker: "UBS",
+    company_name: "Aravt Global",
+    email: "test@aravtglobal.com"
+  )
+
+  resp #=> instance of ONEAccess::Response::BuySideInteractionsResponse
+rescue ONEAccess::Error::APIError => e
+  puts "Error creating buysideinteraction"
+end
+```

data/lib/oneaccess.rb

@@ -28,6 +28,7 @@ require_relative "./oneaccess/api/v1_1/entitlement/research/user_requests"
 require_relative "./oneaccess/api/v3_0/base"
 require_relative "./oneaccess/api/v3_0/references"
 require_relative "./oneaccess/api/v3_0/providers"
+require_relative "./oneaccess/api/v3_0/interactions"
 
 module ONEAccess
   def self.configure

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

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require "date"
+
+require_relative "../../response/buy_side_interactions_response"
+
+module ONEAccess
+  module API
+    module V3_0
+      class Interactions < Base
+        module Types
+          RESEARCH_READERSHIP = "Research Readership"
+        end
+
+        DATE_FORMAT = "%Y-%m-%d %H:%M"
+        DATE_FORMAT_REGEX = /\d{4}-\d{2}-\d{2} \d{2}:\d{2}/
+        private_constant :DATE_FORMAT
+        private_constant :DATE_FORMAT_REGEX
+
+        api_path "/interactions"
+
+        class << self
+          def buy_side_interactions(
+            type:,
+            start_date:,
+            end_date:,
+            user_id:,
+            broker:,
+            company_name:,
+            email:
+          )
+
+            validate_date(start_date)
+            validate_date(end_date)
+
+            response = send_post(
+              "buysideinteractions",
+              payload(type, start_date, end_date, user_id, broker, company_name, email)
+            )
+
+            Response::BuySideInteractionsResponse.from_json(response.body)
+          end
+
+          private
+
+          def validate_date(date_str)
+            raise "Invalid format, must be: yyyy-mm-dd hh:mm, was: #{date_str}" unless valid_date_format?(date_str)
+            raise "Invalid date: #{date_str}" unless valid_date?(date_str)
+
+            nil
+          end
+
+          def valid_date?(date_str, format = DATE_FORMAT)
+            Date.strptime(date_str, format)
+
+            true
+          rescue StandardError
+            false
+          end
+
+          def valid_date_format?(date_str)
+            date_str.match?(DATE_FORMAT_REGEX)
+          end
+
+          def payload(type, start_date, end_date, user_id, broker, company_name, email)
+            {
+              start_date:         start_date,
+              end_date:           end_date,
+              user_id:            user_id.to_s,
+              interaction_type:   type,
+              broker:             broker.to_s,
+              investor:           company_name.to_s,
+              investor_attendees: [{ email: email }]
+            }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/oneaccess/response/buy_side_interactions_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative "./base_response"
+require_relative "./representer/buy_side_interactions_response"
+
+module ONEAccess
+  module Response
+    class BuySideInteractionsResponse < BaseResponse
+      extend Serializable
+
+      attr_accessor :event_id
+
+      represented_by Representer::BuySideInteractionsResponse
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative "./base_response"
+
+module ONEAccess
+  module Response
+    module Representer
+      class BuySideInteractionsResponse < BaseResponse
+        property :event_id, as: :EventId
+      end
+    end
+  end
+end

data/oneaccess.gemspec

@@ -2,8 +2,8 @@
 
 Gem::Specification.new do |s|
   s.name          = "oneaccess"
-  s.version       = "1.0.1"
-  s.date          = "2018-05-07"
+  s.version       = "1.1.0"
+  s.date          = "2018-06-26"
   s.summary       = "ONEAccess API wrapper"
   s.description   = "Easily communicate with ONEAccess API"
   s.homepage      = "https://github.com/AlphaExchange/oneaccess-rb"
@@ -19,6 +19,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency "byebug"
   s.add_development_dependency "rake", "~> 11.3"
   s.add_development_dependency "rspec", "~> 3.6"
+  s.add_development_dependency "rspec-its", "~> 1.2"
   s.add_development_dependency "rubocop", "~> 0.55.0"
   s.add_development_dependency "simplecov"
   s.add_development_dependency "simplecov-console"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oneaccess
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Alex Correia Santos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-07 00:00:00.000000000 Z
+date: 2018-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -198,6 +212,7 @@ files:
 - lib/oneaccess/api/v1_1/symbology.rb
 - lib/oneaccess/api/v1_1/user.rb
 - lib/oneaccess/api/v3_0/base.rb
+- lib/oneaccess/api/v3_0/interactions.rb
 - lib/oneaccess/api/v3_0/providers.rb
 - lib/oneaccess/api/v3_0/references.rb
 - lib/oneaccess/configuration.rb
@@ -259,6 +274,7 @@ files:
 - lib/oneaccess/request/investors_request_handler.rb
 - lib/oneaccess/response/api_error.rb
 - lib/oneaccess/response/base_response.rb
+- lib/oneaccess/response/buy_side_interactions_response.rb
 - lib/oneaccess/response/changed_users_response.rb
 - lib/oneaccess/response/collection_response.rb
 - lib/oneaccess/response/companies_response.rb
@@ -274,6 +290,7 @@ files:
 - 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/buy_side_interactions_response.rb
 - lib/oneaccess/response/representer/changed_users_response.rb
 - lib/oneaccess/response/representer/collection_response.rb
 - lib/oneaccess/response/representer/companies_response.rb