polygon-ruby-client 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 88a32dcdcf095e88b1f0263483dc1f3b1744525e97f243d2d8778224e27bee0d
+  data.tar.gz: 61edd7dd2fbbde5a0e573ef4cb7e3d282859c4ca69254f2517abd20f9da5315b
+SHA512:
+  metadata.gz: a0316425b8e05f75850b5760cb407196acba7a328d3be5caa7ff6db4897b6769b7d27c8cb33019e2204438e4895d69b304f464df9f02a7a1cd492a07d3924173
+  data.tar.gz: f6c8d4f96c22a68b87d3d4ed6b96c2faca782c28c6a16c0fbbd26c1cacffd348f492fc56255d266e742780051df01a26aa4f5b8514ad7645394d56ce9cc517f9

data/.gitignore

@@ -0,0 +1,6 @@
+.env
+pkg
+Gemfile.lock
+.DS_Store
+.bundle
+.idea

data/.rubocop.yml

@@ -0,0 +1,207 @@
+AllCops:
+  TargetRubyVersion: 2.7
+
+Style/AndOr:
+  Enabled: false
+Style/GlobalVars:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Style/MultilineIfModifier:
+  Enabled: false
+Security/JSONLoad:
+  Enabled: false
+
+Style/RescueModifier:
+  Enabled: false
+
+Naming/MethodParameterName:
+  MinNameLength: 1
+
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+Lint/RaiseException:
+  Enabled: true
+Lint/StructNewOverride:
+  Enabled: true
+Style/ExponentialNotation:
+  Enabled: true
+Style/HashEachMethods:
+  Enabled: true
+Style/HashTransformKeys:
+  Enabled: true
+Style/HashTransformValues:
+  Enabled: true
+
+# Style/Alias:
+#   Enabled: false
+#   StyleGuide: https://relaxed.ruby.style/#stylealias
+
+# Style/AsciiComments:
+#   Enabled: false
+#   StyleGuide: https://relaxed.ruby.style/#styleasciicomments
+
+# Style/BeginBlock:
+#   Enabled: false
+#   StyleGuide: https://relaxed.ruby.style/#stylebeginblock
+
+# Style/BlockDelimiters:
+#   Enabled: false
+#   StyleGuide: https://relaxed.ruby.style/#styleblockdelimiters
+
+Style/CommentAnnotation:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylecommentannotation
+
+Style/Documentation:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styledocumentation
+
+# Layout/DotPosition:
+#   Enabled: false
+#   StyleGuide: https://relaxed.ruby.style/#layoutdotposition
+
+# Style/DoubleNegation:
+#   Enabled: false
+#   StyleGuide: https://relaxed.ruby.style/#styledoublenegation
+
+# Style/EndBlock:
+#   Enabled: false
+#   StyleGuide: https://relaxed.ruby.style/#styleendblock
+
+# Style/FormatString:
+#   Enabled: false
+#   StyleGuide: https://relaxed.ruby.style/#styleformatstring
+
+# Style/IfUnlessModifier:
+#   Enabled: false
+#   StyleGuide: https://relaxed.ruby.style/#styleifunlessmodifier
+
+# Style/Lambda:
+#   Enabled: false
+#   StyleGuide: https://relaxed.ruby.style/#stylelambda
+
+# Style/ModuleFunction:
+#   Enabled: false
+#   StyleGuide: https://relaxed.ruby.style/#stylemodulefunction
+
+# Style/MultilineBlockChain:
+#   Enabled: false
+#   StyleGuide: https://relaxed.ruby.style/#stylemultilineblockchain
+
+# Style/NegatedIf:
+#   Enabled: false
+#   StyleGuide: https://relaxed.ruby.style/#stylenegatedif
+
+# Style/NegatedWhile:
+#   Enabled: false
+#   StyleGuide: https://relaxed.ruby.style/#stylenegatedwhile
+
+# Style/NumericPredicate:
+#   Enabled: false
+#   StyleGuide: https://relaxed.ruby.style/#stylenumericpredicate
+
+# Style/ParallelAssignment:
+#   Enabled: false
+#   StyleGuide: https://relaxed.ruby.style/#styleparallelassignment
+
+# Style/PercentLiteralDelimiters:
+#   Enabled: false
+#   StyleGuide: https://relaxed.ruby.style/#stylepercentliteraldelimiters
+
+# Style/PerlBackrefs:
+#   Enabled: false
+#   StyleGuide: https://relaxed.ruby.style/#styleperlbackrefs
+
+# Style/Semicolon:
+#   Enabled: false
+#   StyleGuide: https://relaxed.ruby.style/#stylesemicolon
+
+# Style/SignalException:
+#   Enabled: false
+#   StyleGuide: https://relaxed.ruby.style/#stylesignalexception
+
+# Style/SingleLineBlockParams:
+#   Enabled: false
+#   StyleGuide: https://relaxed.ruby.style/#stylesinglelineblockparams
+
+# Style/SingleLineMethods:
+#   Enabled: false
+#   StyleGuide: https://relaxed.ruby.style/#stylesinglelinemethods
+
+# Layout/SpaceBeforeBlockBraces:
+#   Enabled: false
+#   StyleGuide: https://relaxed.ruby.style/#layoutspacebeforeblockbraces
+
+# Layout/SpaceInsideParens:
+#   Enabled: false
+#   StyleGuide: https://relaxed.ruby.style/#layoutspaceinsideparens
+
+# Style/SpecialGlobalVars:
+#   Enabled: false
+#   StyleGuide: https://relaxed.ruby.style/#stylespecialglobalvars
+
+# Style/StringLiterals:
+#   Enabled: false
+#   StyleGuide: https://relaxed.ruby.style/#stylestringliterals
+
+# Style/TrailingCommaInArguments:
+#   Enabled: false
+#   StyleGuide: https://relaxed.ruby.style/#styletrailingcommainarguments
+
+# Style/TrailingCommaInArrayLiteral:
+#   Enabled: false
+#   StyleGuide: https://relaxed.ruby.style/#styletrailingcommainarrayliteral
+
+# Style/TrailingCommaInHashLiteral:
+#   Enabled: false
+#   StyleGuide: https://relaxed.ruby.style/#styletrailingcommainhashliteral
+
+# Style/SymbolArray:
+#   Enabled: false
+#   StyleGuide: http://relaxed.ruby.style/#stylesymbolarray
+
+# Style/WhileUntilModifier:
+#   Enabled: false
+#   StyleGuide: https://relaxed.ruby.style/#stylewhileuntilmodifier
+
+# Style/WordArray:
+#   Enabled: false
+#   StyleGuide: https://relaxed.ruby.style/#stylewordarray
+
+# Lint/AmbiguousRegexpLiteral:
+#   Enabled: false
+#   StyleGuide: https://relaxed.ruby.style/#lintambiguousregexpliteral
+
+# Lint/AssignmentInCondition:
+#   Enabled: false
+#   StyleGuide: https://relaxed.ruby.style/#lintassignmentincondition
+
+Metrics/AbcSize:
+  Enabled: false
+
+# Metrics/BlockNesting:
+#   Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Layout/LineLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false

data/README.md

@@ -0,0 +1,8 @@
+# polygon-ruby-client
+Polygon.io API ruby client
+
+Example usage:
+```ruby
+client = Polygon::Api::Client.new(api_key: 'xxx')
+client.trades('AAPL', '2020-08-14', {limit: 100})
+```

data/lib/faraday_middleware/parse_oj.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module FaradayMiddleware
+  class ParseOj < ResponseMiddleware
+    dependency 'oj'
+
+    define_parser do |body|
+      Oj.load(body, mode: :compat, symbol_keys: true) unless body.strip.empty?
+    end
+  end
+end
+
+Faraday::Response.register_middleware oj: FaradayMiddleware::ParseOj

data/lib/polygon-ruby-client.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require 'oj'
+require 'faraday_middleware'
+require 'faraday_middleware/response_middleware'
+require_relative 'faraday_middleware/parse_oj'
+
+require_relative 'polygon/version'
+require_relative 'polygon/logger'
+require_relative 'polygon/api'

data/lib/polygon/api.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require_relative 'api/endpoints'
+require_relative 'api/connection'
+require_relative 'api/request'
+require_relative 'api/config'
+require_relative 'api/client'

data/lib/polygon/api/client.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Polygon
+  module Api
+    class Client
+      include Endpoints
+      include Connection
+      include Request
+      include Config
+
+      def initialize(options = {})
+        Config::ATTRIBUTES.each do |key|
+          send("#{key}=", options[key] || Polygon::Api.config.send(key))
+        end
+      end
+    end
+  end
+end

data/lib/polygon/api/config.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Polygon
+  module Api
+    module Config
+      extend self
+
+      ATTRIBUTES = %i[
+        proxy
+        user_agent
+        ca_path
+        ca_file
+        logger
+        timeout
+        open_timeout
+        endpoint
+        api_key
+      ].freeze
+
+      attr_accessor(*Config::ATTRIBUTES)
+
+      def reset!
+        self.endpoint = 'https://api.polygon.io'
+        self.api_key = ENV['POLYGON_API_KEY']
+        self.user_agent = "Polygon Ruby Client/#{Polygon::VERSION}"
+        self.ca_path = defined?(OpenSSL) ? OpenSSL::X509::DEFAULT_CERT_DIR : nil
+        self.ca_file = defined?(OpenSSL) ? OpenSSL::X509::DEFAULT_CERT_FILE : nil
+        self.proxy = nil
+        self.logger = nil
+        self.timeout = nil
+        self.open_timeout = nil
+      end
+    end
+
+    class << self
+      def configure
+        block_given? ? yield(Config) : Config
+      end
+
+      def config
+        Config
+      end
+    end
+  end
+end
+
+Polygon::Api::Config.reset!

data/lib/polygon/api/connection.rb

@@ -0,0 +1,36 @@
+module Polygon
+  module Api
+    module Connection
+      private
+
+      def headers
+        {}
+      end
+
+      def connection
+        @connection ||= begin
+          options = {}
+
+          options[:headers] = {}
+          options[:headers]['Accept'] = 'application/json; charset=utf-8'
+          options[:headers]['Content-Type'] = 'application/json; charset=utf-8'
+          options[:headers]['User-Agent'] = user_agent if user_agent
+          options[:proxy] = proxy if proxy
+          options[:ssl] = { ca_path: ca_path, ca_file: ca_file } if ca_path || ca_file
+
+          request_options = {}
+          request_options[:timeout] = timeout if timeout
+          request_options[:open_timeout] = open_timeout if open_timeout
+          request_options[:params_encoder] = Faraday::FlatParamsEncoder
+          options[:request] = request_options if request_options.any?
+
+          ::Faraday::Connection.new(endpoint, options) do |connection|
+            connection.use ::FaradayMiddleware::ParseOj, content_type: /\bjson$/
+            connection.response :logger, logger if logger
+            connection.adapter ::Faraday.default_adapter
+          end
+        end
+      end
+    end
+  end
+end

data/lib/polygon/api/endpoints.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Polygon
+  module Api
+    module Endpoints
+      def trades(symbol, date, options = {})
+        get("/v2/ticks/stocks/trades/#{symbol}/#{date}", { apiKey: api_key }.merge(options))
+      end
+    end
+  end
+end

data/lib/polygon/api/request.rb

@@ -0,0 +1,38 @@
+module Polygon
+  module Api
+    module Request
+      def get(path, options = {})
+        request(:get, path, options)
+      end
+
+      def post(path, options = {})
+        request(:post, path, options)
+      end
+
+      def put(path, options = {})
+        request(:put, path, options)
+      end
+
+      def delete(path, options = {})
+        request(:delete, path, options)
+      end
+
+      private
+
+      def request(method, path, options)
+        path = [endpoint, path].join
+        response = connection.send(method) do |request|
+          case method
+          when :get, :delete
+            request.url(path, options)
+          when :post, :put
+            request.path = path
+            request.body = options.to_json unless options.empty?
+          end
+          request.options.merge!(options.delete(:request)) if options.key?(:request)
+        end
+        response.body
+      end
+    end
+  end
+end

data/lib/polygon/logger.rb

@@ -0,0 +1,13 @@
+require 'logger'
+
+module Polygon
+  class Logger < ::Logger
+    def self.logger
+      @logger ||= begin
+        logger = new STDOUT
+        logger.level = Logger::WARN
+        logger
+      end
+    end
+  end
+end

data/lib/polygon/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Polygon
+  VERSION = '1.0.0'
+end

data/polygon-ruby-client.gemspec

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.push File.expand_path('lib', __dir__)
+require 'polygon/version'
+
+Gem::Specification.new do |s|
+  s.name = 'polygon-ruby-client'
+  s.bindir = 'bin'
+  s.version = Polygon::VERSION
+  s.authors = ['Alex Yussupov']
+  s.email = 'alex@klepa.co'
+  s.platform = Gem::Platform::RUBY
+  s.required_rubygems_version = '>= 1.3.6'
+  s.required_ruby_version = '>= 2.3.0'
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- spec/*`.split("\n")
+  s.require_paths = ['lib']
+  s.homepage = 'http://github.com/alex-klepa/polygon-ruby-client'
+  s.licenses = ['MIT']
+  s.summary = 'Polygon API.'
+  s.add_dependency 'faraday', '>= 1.00'
+  s.add_dependency 'faraday_middleware'
+  s.add_dependency 'oj'
+  s.add_development_dependency 'rake', '~> 10'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'rubocop', '0.72.0'
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: polygon-ruby-client
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Alex Yussupov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-08-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.00'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.00'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.72.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.72.0
+description: 
+email: alex@klepa.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- README.md
+- lib/faraday_middleware/parse_oj.rb
+- lib/polygon-ruby-client.rb
+- lib/polygon/api.rb
+- lib/polygon/api/client.rb
+- lib/polygon/api/config.rb
+- lib/polygon/api/connection.rb
+- lib/polygon/api/endpoints.rb
+- lib/polygon/api/request.rb
+- lib/polygon/logger.rb
+- lib/polygon/version.rb
+- polygon-ruby-client.gemspec
+homepage: http://github.com/alex-klepa/polygon-ruby-client
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Polygon API.
+test_files: []