iex-ruby-client 1.6.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 842d8fd485aebd159c318088ca1137348555a4a2106e4e4089da3e13ecc596eb
-  data.tar.gz: dc2046dd1efbd5c0593134fa99daf5a280f62c629c2779d785f5f34f41896c6a
+  metadata.gz: a15ce3455468f791bbe21989defd92328cb979d2f803ee94de76069c798e9354
+  data.tar.gz: eceab7355f2c4e291004a138f9a39fb5001b4b6e95bea5fb5ceb45babee65ed0
 SHA512:
-  metadata.gz: 543f9a5bea937226e974b430654c53d4fab1f4cbb79d025784888f6a4924aeb2c59bcceb2214257a78544274c217f555594cc100a9820dae2b8f90d72ef9b1ae
-  data.tar.gz: 205d65bf85cfd152e4cddb8f6344658cea65a12201aceba42a43a52a524efcbf02e9695ddfa543c99b5fc90f402b096e490fe6341697fbb07e7de5a5a7961c72
+  metadata.gz: 967562f47076ba6c8f3a4a4f8c9ac5c414570c3c9b90cf661d13e2eb8ab970913efb810268ecdd379ad6f2f1101ac9b7d00acb81a2b4dd5ec03ba469f1b84886
+  data.tar.gz: a889e0b0504c02a9d2a21b12555ae496c7a402606d129848faed9139ba225b4e88a242eed80d0ab6fe92d65975562c100187cf476152079d04c1bd7616d1b03e

data/.github/workflows/danger.yml

@@ -0,0 +1,20 @@
+name: PR Linter
+on: [pull_request]
+jobs:
+  danger:
+    runs-on: ubuntu-latest
+    env:
+      BUNDLE_GEMFILE: ${{ github.workspace }}/Gemfile.danger
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.7
+          bundler-cache: true
+      - run: |
+          # the personal token is public, this is ok, base64 encode to avoid tripping Github
+          TOKEN=$(echo -n NWY1ZmM5MzEyMzNlYWY4OTZiOGU3MmI3MWQ3Mzk0MzgxMWE4OGVmYwo= | base64 --decode)
+          DANGER_GITHUB_API_TOKEN=$TOKEN bundle exec danger --verbose

data/.github/workflows/rubocop.yml

@@ -0,0 +1,14 @@
+name: Rubocop
+on: [push, pull_request]
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.7
+          bundler-cache: true
+      - name: Run Rubocop
+        run: bundle exec rubocop

data/.github/workflows/test.yml

@@ -0,0 +1,25 @@
+name: Tests
+on: [push, pull_request]
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        entry:
+          - { ruby: "2.7" }
+          - { ruby: "3.0" }
+          - { ruby: "3.1" }
+          - { ruby: ruby-head, ignore: true }
+          - { ruby: jruby-head, ignore: true }
+    name: test (ruby=${{ matrix.entry.ruby }})
+    steps:
+      - uses: actions/checkout@v2
+      - name: Install Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.entry.ruby }}
+      - name: Run Tests
+        continue-on-error: ${{ matrix.entry.ignore || false }}
+        run: |
+          bundle install
+          bundle exec rspec

data/.gitignore

@@ -5,3 +5,4 @@ Gemfile.lock
 .bundle
 .idea
 .irbrc
+.tool-versions

data/.rubocop.yml

@@ -1,6 +1,7 @@
 AllCops:
   Exclude:
     - vendor/**/*
+  TargetRubyVersion: 2.4
 
 Style/FrozenStringLiteralComment:
   Enabled: false

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2019-04-19 14:36:19 -0400 using RuboCop version 0.67.2.
+# on 2022-07-21 13:04:05 -0500 using RuboCop version 0.75.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -11,3 +11,10 @@
 Style/AsciiComments:
   Exclude:
     - 'lib/iex/resources/quote.rb'
+
+# Offense count: 2
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: annotated, template, unannotated
+Style/FormatStringToken:
+  Exclude:
+    - 'lib/iex/resources/resource.rb'

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+### 2.0.0 (2022/07/24)
+* [#111](https://github.com/dblock/iex-ruby-client/pull/111): Added support for fetching symbols for a region - [@mathu97](https://github.com/mathu97).
+* [#111](https://github.com/dblock/iex-ruby-client/pull/111): Added `Symbols#exchange_suffix`, `exchange_name`, `exchange_segment`, `exchange_segment_name`, and `lei` - [@mathu97](https://github.com/mathu97).
+* [#113](https://github.com/dblock/iex-ruby-client/pull/113): Explicitly require Ruby >= 2.4 - [@agrberg](https://github.com/agrberg).
+* [#113](https://github.com/dblock/iex-ruby-client/pull/113): Remove default SSL options for `ca_file` and `ca_path` - [@agrberg](https://github.com/agrberg).
+
 ### 1.6.0 (2021/10/17)
 * [#110](https://github.com/dblock/iex-ruby-client/pull/110): Drop `money_helper` dependency and utilize `money` gem directly - [@agrberg](https://github.com/agrberg).
 

data/CONTRIBUTING.md

@@ -114,7 +114,7 @@ git push origin my-feature-branch -f
 
 ### Check on Your Pull Request
 
-Go back to your pull request after a few minutes and see whether it passed muster with Travis-CI. Everything should look green, otherwise fix issues and amend your commit as described above.
+Go back to your pull request after a few minutes and see whether it passed muster with GitHub Actions. Everything should look green, otherwise fix issues and amend your commit as described above.
 
 ### Be Patient
 

data/Gemfile.danger

@@ -0,0 +1,6 @@
+source 'http://rubygems.org'
+
+group :test do
+  gem 'danger-changelog', '~> 0.6.0', require: false
+  gem 'danger-toc', '~> 0.2.0', require: false
+end

data/README.md

@@ -1,7 +1,7 @@
 # IEX Finance API
 
 [![Gem Version](https://badge.fury.io/rb/iex-ruby-client.svg)](https://badge.fury.io/rb/iex-ruby-client)
-[![Build Status](https://travis-ci.org/dblock/iex-ruby-client.svg?branch=master)](https://travis-ci.org/dblock/iex-ruby-client)
+[![Build Status](https://github.com/dblock/iex-ruby-client/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/dblock/iex-ruby-client/actions/workflows/test.yml)
 
 A Ruby client for the [The IEX Cloud API](https://iexcloud.io/docs/api/).
 
@@ -33,6 +33,7 @@ A Ruby client for the [The IEX Cloud API](https://iexcloud.io/docs/api/).
   - [ISIN Mapping](#isin-mapping)
   - [Get Symbols](#get-symbols)
   - [Get Symbols for an Exchange](#get-symbols-for-an-exchange)
+  - [Get Symbols for a Region](#get-symbols-for-a-region)
   - [Get Latest Foreign Exchange Rates](#get-latest-foreign-exchange-rates)
   - [Get List](#get-list)
   - [Other Requests](#other-requests)
@@ -578,13 +579,13 @@ See [#symbols](https://iexcloud.io/docs/api/#symbols) for detailed documentation
 
 ### Get Symbols for an Exchange
 
-Returns an array of symbols for a given exchange.
+Returns an array of symbols for an exchange identified by a market identifier code.
 
 ```ruby
-symbols = client.ref_data_symbols_for_exchange('TSX')
+symbols = client.ref_data_symbols_for_exchange('XTSE')
 
 symbol = symbols.first
-symbol.exchange # TSX
+symbol.exchange # XTSE
 symbol.iex_id # IEX_4656374258322D52
 symbol.region # CA
 symbol.symbol # A-CV
@@ -592,6 +593,20 @@ symbol.symbol # A-CV
 
 See [#international-symbols](https://iexcloud.io/docs/api/#international-symbols) for returned fields.
 
+### Get Symbols for a Region
+
+Returns an array of symbols for a region.
+
+```ruby
+symbols = client.ref_data_symbols_for_region('ca')
+
+symbol = symbols.first
+symbol.exchange # XTSE
+symbol.iex_id # IEX_4656374258322D53
+symbol.region # CA
+symbol.symbol # A-CT
+```
+
 ### Get Latest Foreign Exchange Rates
 
 Returns an array of foreign exchange rates for a given list of symbols.

data/RELEASING.md

@@ -11,7 +11,7 @@ bundle install
 rake
 ```
 
-Check that the last build succeeded in [Travis CI](https://travis-ci.com/github/dblock/iex-ruby-client) for all supported platforms.
+Check that the last build succeeded in [GitHub Actions](https://github.com/dblock/iex-ruby-client/actions/workflows/test.yml) for all supported platforms.
 
 Change "Next" in [CHANGELOG.md](CHANGELOG.md) to the current date.
 

data/UPGRADING.md

@@ -1,6 +1,21 @@
 Upgrading iex-ruby-client
 =========================
 
+### Upgrading to >= 2.0.0
+
+[#113](https://github.com/dblock/iex-ruby-client/pull/113) Minimum Ruby version is 2.4
+
+[#113](https://github.com/dblock/iex-ruby-client/pull/113) Removes default values for Faraday's SSL settings `ca_file` and `ca_path`.
+
+If you previously relied on `OpenSSL::X509::DEFAULT_CERT_FILE` or `OpenSSL::X509::DEFAULT_CERT_DIR` to set these values you must now do so explicitly. E.g.:
+
+```ruby
+IEX::Api.configure do |config|
+  config.ca_file = OpenSSL::X509::DEFAULT_CERT_FILE
+  config.ca_path = OpenSSL::X509::DEFAULT_CERT_DIR
+end
+```
+
 ### Upgrading to >= 1.6.0
 
 [#110](https://github.com/dblock/iex-ruby-client/pull/110) drops the dependency on `money_helper` in favor of using the `money` library directly.

data/iex-ruby-client.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   s.email = 'dblock@dblock.org'
   s.platform = Gem::Platform::RUBY
   s.required_rubygems_version = '>= 1.3.6'
-  s.required_ruby_version = '>= 2.3.0'
+  s.required_ruby_version = '>= 2.4.0'
   s.files = `git ls-files`.split("\n")
   s.test_files = `git ls-files -- spec/*`.split("\n")
   s.require_paths = ['lib']
@@ -22,7 +22,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'money', '~> 6.0'
   s.add_development_dependency 'rake', '~> 10'
   s.add_development_dependency 'rspec'
-  s.add_development_dependency 'rubocop', '0.72.0'
+  s.add_development_dependency 'rubocop', '0.75.0'
   s.add_development_dependency 'vcr'
   s.add_development_dependency 'webmock'
 end

data/lib/iex/api/config/client.rb

@@ -21,13 +21,13 @@ module IEX
           attr_accessor(*ATTRIBUTES)
 
           def reset!
-            self.ca_file = defined?(OpenSSL) ? OpenSSL::X509::DEFAULT_CERT_FILE : nil
-            self.ca_path = defined?(OpenSSL) ? OpenSSL::X509::DEFAULT_CERT_DIR : nil
             self.endpoint = 'https://cloud.iexapis.com/v1'
             self.publishable_token = ENV['IEX_API_PUBLISHABLE_TOKEN']
             self.secret_token = ENV['IEX_API_SECRET_TOKEN']
             self.user_agent = "IEX Ruby Client/#{IEX::VERSION}"
 
+            self.ca_file = nil
+            self.ca_path = nil
             self.open_timeout = nil
             self.proxy = nil
             self.referer = nil

data/lib/iex/endpoints/ref_data.rb

@@ -22,6 +22,11 @@ module IEX
         response = get("ref-data/exchange/#{exchange}/symbols", { token: publishable_token }.merge(options))
         response.map { |row| IEX::Resources::Symbols.new(row) }
       end
+
+      def ref_data_symbols_for_region(region, options = {})
+        response = get("ref-data/region/#{region}/symbols", { token: publishable_token }.merge(options))
+        response.map { |row| IEX::Resources::Symbols.new(row) }
+      end
     end
   end
 end

data/lib/iex/resources/symbols.rb

@@ -3,6 +3,10 @@ module IEX
     class Symbols < Resource
       property 'symbol'
       property 'exchange'
+      property 'exchange_suffix', from: 'exchangeSuffix'
+      property 'exchange_name', from: 'exchangeName'
+      property 'exchange_segment', from: 'exchangeSegment'
+      property 'exchange_segment_name', from: 'exchangeSegmentName'
       property 'name'
       property 'date', transform_with: ->(v) { Date.parse(v) }
       property 'enabled', from: 'isEnabled'
@@ -12,6 +16,7 @@ module IEX
       property 'iex_id', from: 'iexId'
       property 'figi'
       property 'cik'
+      property 'lei'
 
       alias :enabled? enabled
     end

data/lib/iex/version.rb

@@ -1,3 +1,3 @@
 module IEX
-  VERSION = '1.6.0'.freeze
+  VERSION = '2.0.0'.freeze
 end