twelvedata_ruby 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 875e9a7aa6d49ba856df319540c987e48ac4fd04ab8cf10f80d804ac685b27c0
+  data.tar.gz: 3db748bb0a8945897b87748bd49705a9e435523f71c9c572eadd38363ff5b044
+SHA512:
+  metadata.gz: da38162ec79f04bd05c69baa4ee8aa26c2419f557503fe6850f7babd3b10125536bc54e444000a8a8876ea99c754f38b195b6f5227130081f258945ef0bae7c5
+  data.tar.gz: a3bb92af00adeff804939396c2423a087bccfde71c12905b2a5e047aa4d93c5b446eed6ae123310490e7b9aacd23f6beaa2d5fa7314304a33163ff6d03a35f58

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec
+.rspec_status
+.history
+.vscode

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-07-05
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at TODO: Write your email address. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in twelvedata_ruby.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,80 @@
+PATH
+  remote: .
+  specs:
+    twelvedata_ruby (0.1.1)
+      httpx (~> 0.14.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.4.4)
+    docile (1.4.0)
+    hashdiff (1.0.1)
+    http-2-next (0.4.3)
+    httpx (0.14.5)
+      http-2-next (>= 0.4.1)
+      timers
+    parallel (1.20.1)
+    parser (3.0.1.1)
+      ast (~> 2.4.1)
+    public_suffix (4.0.6)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.7.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.7.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.3)
+    timers (4.3.3)
+    unicode-display_width (2.0.0)
+    webmock (3.13.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  x86_64-darwin-18
+
+DEPENDENCIES
+  rake (~> 13.0, >= 13.0.3)
+  rspec (~> 3.10.0)
+  rubocop (~> 1.17.0)
+  simplecov (~> 0.21, >= 0.21.2)
+  twelvedata_ruby!
+  webmock (~> 3.13, >= 3.13.0)
+
+BUNDLED WITH
+   2.2.17

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 TODO: Write your name
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,125 @@
+# TwelvedataRuby
+
+
+TwelvedataRuby is a Ruby library that exposes some convenient ways to access Twelve Data API to get information on stock, forex, crypto, and other financial market data. In order to do so, a free API key is required which can be easily requested [here](https://twelvedata.com/pricing). Visit their [API's full documentation](https://twelvedata.com/doc)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'twelvedata_ruby'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install twelvedata_ruby
+
+## Usage
+
+The preferred way to include the Twelve Data API key in the request payload is to assign it to an ENVIRONMENT variable which your Ruby application can fetch if none was explicitly assigned. The default ENVIRONMENTt variable name is `TWELVEDATA_API_KEY` but you can configure this to any other value  using the `#apikey_env_var_name=` setter method.
+
+To get hold of the singleton `TwelvedataRuby::Client.instance`, you can directly used that inherited instance method from the mixed in `Singleton` module or thru the gem's module helper class method:
+
+```ruby
+require "twelvedata_ruby"
+client = TwelvedataRuby.client
+```
+
+By not passing anything to the options method parameters, the `client` instance attributes will have default values. Though you can still set different values to the attributes through their helper setter methods:
+
+```ruby
+client.apikey = "twelvedata-apikey"
+client.apikey_env_var_name = "the_environment_variable_name" # the helper getter method will upcase the value
+client.connect_timeout = 300 # can also accept "300"
+```
+
+or simply set them all at once:
+
+```ruby
+require "twelvedata_ruby"
+client = TwelvedataRuby.client(apikey: "twelvedata-apikey", connect_timeout: 300)
+# or client = TwelvedataRuby.client(apikey_env_var_name: "the_environment_variable_name", connect_timeout: 300)
+```
+
+The default values though are sufficient already.
+
+Getting any type of financial data then from the API, simply invoke any valid endpoint name to the client instance. For example, to fetch some data for `GOOG` stock symbol using quote, timeseries, price, and etd API endpoints:
+
+```ruby
+# 1. response content-type will be :csv
+client.quote(symbol: "GOOG", format: :csv)
+# 2. assigns custom attachment name
+client.timeseries(symbol: "GOOG", interval: "1hour", format: :csv, filename: "google_timeseries_1hour.csv")
+# 3. the content-type format will be :json
+client.price(symbol: "GOOG")
+# 4. the passed apikey is the used in the request payload
+client.etd(symbol: "GOOG", apikey: "overrides-whatever-is-the-current-apikey")
+# 5. an example of invocation which the API will respond with 401 error code
+client.etd(symbol: "GOOG", apikey: "invalid-api-key")
+# 6. still exactly the same object with client
+TwelvedataRuby.client.api_usage
+# 7. an invalid request wherein the required query parameter :interval is missing
+TwelvedataRuby.client.timeseries(symbol: "GOOG")
+# 8. an invalid request because it contains an invalid parameter
+client.price(symbol: "GOOG", invalid_parameter: "value")
+# 9. invoking a non-existing API endpoint will cause a NoMethodError exception
+client.price(symbol: "GOOG", invalid_parameter: "value")
+```
+
+All of the invocations possible return instance value is one of the following:
+- `TwelvedataRuby::Response` instance object which `#error` instance getter method can return a nil or kind of `TwelvedataRuby::ResponseError` instance if the API, or the API web server responded with some errors. #5 is an example which the API response will have status error with 401 code. `TwelvedataRuby::Response` resolves this into `TwelvedataRuby::UnauthorizedResponseError` instance.
+- `TwelvedataRuby::ResponseError` instance object itself when some error occurred that's not coming from the API
+- a Hash instance which has an `:errors` key that contains instances of kind `TwelvedataRuby::EndpointError`. This is an invalid request scenario which the #7, #8, and #9 examples. No actual API request was sent in this scenario.
+
+On first invocation of a valid endpoint name, a `TwelvedataRuby::Client` instance method of the same name is dynamically defined. So in effect, ideally, there can be a one-to-one mapping of all the API endpoints with their respective parameters constraints. Please visit their excellent API documentation to know more of the endpoint details here https://twelvedata.com/doc. Or if you're in a hurry, you can list the endpoints definitions:
+
+```ruby
+TwelvedataRuby::Endpoint.definitions
+```
+
+Another way of fetching data from API endpoints is by building a valid `TwelvedataRuby::Request` instance, then invoke `#fetch` on this instance. The possible return values are the same with the above examples.
+
+```ruby
+quote_req = TwelvedataRuby::Request.new(:quote, symbol: "IBM")
+quote_resp = quote_req.fetch
+timeseries_req = TwelvedataRuby::Request.new(:quote, symbol: "IBM", interval: "1hour", format: :csv)
+timeseries_resp = timeseries_req.fetch
+etd_req = TwelvedataRuby::Request.new(:etd, symbol: "GOOG")
+etd_resp = etd_req.fetch
+# or just simply chain
+price_resp = TwelvedataRuby::Request.new(:price, symbol: "GOOG").fetch
+```
+
+An advantage of building a valid request instance first then invoke the `#fetch` on it is you actually have an option to not send the request one by one BUT rather send them to the API server all at once simultaneously (might be in parallel). Like so taking the above examples' request instance objects, send them all simultaneously
+
+```ruby
+# returns a 3 element array of Response objects
+resp_objects_array = TwelvedataRuby::Client.request(quote_req, timeseries_req, etd_req)
+```
+
+Be caution that the above example, depending on the number request objects sent and how large the responses, hitting the daily limit is likely possible. But then again if you have several api keys you might be able to supply each request object with its own apikey. :)
+
+
+TODO: write more documenation especially the response object
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/twelvedata_ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/twelvedata_ruby/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the TwelvedataRuby project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/twelvedata_ruby/blob/master/CODE_OF_CONDUCT.md).
+
+
+# Notice
+
+This is not an offical Twelve Data ruby library and the author of this gem is not affiliated with Twelve Data in any way, shape or form. Twelve Data APIs and data are Copyright © 2020 Twelve Data Pte. Ltd

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "twelvedata_ruby"
+
+require "irb"
+
+def reload!
+  root_dir = File.expand_path("..", __dir__)
+  orig_verbose = $VERBOSE
+  # suppresss annoying already initialized warnings
+  $VERBOSE = nil
+  puts "Reloading with suppressed warning messages about 'already initialized'..."
+  %w[lib].each do |dir|
+    Dir.glob("#{root_dir}/#{dir}/**/*.rb").each {|f| load(f) }
+  end
+  $VERBOSE = orig_verbose
+  true
+end
+
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/doc/TwelvedataRuby.html

@@ -0,0 +1,353 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Module: TwelvedataRuby
+  
+    &mdash; Documentation by YARD 0.9.26
+  
+</title>
+
+  <link rel="stylesheet" href="css/style.css" type="text/css" />
+
+  <link rel="stylesheet" href="css/common.css" type="text/css" />
+
+<script type="text/javascript">
+  pathId = "TwelvedataRuby";
+  relpath = '';
+</script>
+
+
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+
+
+  </head>
+  <body>
+    <div class="nav_wrap">
+      <iframe id="nav" src="class_list.html?1"></iframe>
+      <div id="resizer"></div>
+    </div>
+
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <div id="menu">
+  
+    <a href="_index.html">Index (T)</a> &raquo;
+    
+    
+    <span class="title">TwelvedataRuby</span>
+  
+</div>
+
+        <div id="search">
+  
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+  
+</div>
+        <div class="clear"></div>
+      </div>
+
+      <div id="content"><h1>Module: TwelvedataRuby
+  
+  
+  
+</h1>
+<div class="box_info">
+  
+
+  
+  
+  
+  
+  
+
+  
+
+  
+  <dl>
+    <dt>Defined in:</dt>
+    <dd>lib/twelvedata_ruby.rb<span class="defines">,<br />
+  lib/twelvedata_ruby/error.rb,<br /> lib/twelvedata_ruby/utils.rb,<br /> lib/twelvedata_ruby/client.rb,<br /> lib/twelvedata_ruby/request.rb,<br /> lib/twelvedata_ruby/endpoint.rb,<br /> lib/twelvedata_ruby/response.rb</span>
+</dd>
+  </dl>
+  
+</div>
+
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    
+<p>The one module that all the classes and modules of this gem are namespaced</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><h2>Defined Under Namespace</h2>
+<p class="children">
+  
+    
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="TwelvedataRuby/Utils.html" title="TwelvedataRuby::Utils (module)">Utils</a></span>
+    
+  
+    
+      <strong class="classes">Classes:</strong> <span class='object_link'><a href="TwelvedataRuby/BadRequestResponseError.html" title="TwelvedataRuby::BadRequestResponseError (class)">BadRequestResponseError</a></span>, <span class='object_link'><a href="TwelvedataRuby/Client.html" title="TwelvedataRuby::Client (class)">Client</a></span>, <span class='object_link'><a href="TwelvedataRuby/Endpoint.html" title="TwelvedataRuby::Endpoint (class)">Endpoint</a></span>, <span class='object_link'><a href="TwelvedataRuby/EndpointError.html" title="TwelvedataRuby::EndpointError (class)">EndpointError</a></span>, <span class='object_link'><a href="TwelvedataRuby/EndpointNameError.html" title="TwelvedataRuby::EndpointNameError (class)">EndpointNameError</a></span>, <span class='object_link'><a href="TwelvedataRuby/EndpointParametersKeysError.html" title="TwelvedataRuby::EndpointParametersKeysError (class)">EndpointParametersKeysError</a></span>, <span class='object_link'><a href="TwelvedataRuby/EndpointRequiredParametersError.html" title="TwelvedataRuby::EndpointRequiredParametersError (class)">EndpointRequiredParametersError</a></span>, <span class='object_link'><a href="TwelvedataRuby/Error.html" title="TwelvedataRuby::Error (class)">Error</a></span>, <span class='object_link'><a href="TwelvedataRuby/ForbiddenResponseError.html" title="TwelvedataRuby::ForbiddenResponseError (class)">ForbiddenResponseError</a></span>, <span class='object_link'><a href="TwelvedataRuby/InternalServerResponseErro.html" title="TwelvedataRuby::InternalServerResponseErro (class)">InternalServerResponseErro</a></span>, <span class='object_link'><a href="TwelvedataRuby/NotFoundResponseError.html" title="TwelvedataRuby::NotFoundResponseError (class)">NotFoundResponseError</a></span>, <span class='object_link'><a href="TwelvedataRuby/PageNotFoundResponseError.html" title="TwelvedataRuby::PageNotFoundResponseError (class)">PageNotFoundResponseError</a></span>, <span class='object_link'><a href="TwelvedataRuby/ParameterTooLongResponseError.html" title="TwelvedataRuby::ParameterTooLongResponseError (class)">ParameterTooLongResponseError</a></span>, <span class='object_link'><a href="TwelvedataRuby/Request.html" title="TwelvedataRuby::Request (class)">Request</a></span>, <span class='object_link'><a href="TwelvedataRuby/Response.html" title="TwelvedataRuby::Response (class)">Response</a></span>, <span class='object_link'><a href="TwelvedataRuby/ResponseError.html" title="TwelvedataRuby::ResponseError (class)">ResponseError</a></span>, <span class='object_link'><a href="TwelvedataRuby/TooManyRequestsResponseError.html" title="TwelvedataRuby::TooManyRequestsResponseError (class)">TooManyRequestsResponseError</a></span>, <span class='object_link'><a href="TwelvedataRuby/UnauthorizedResponseError.html" title="TwelvedataRuby::UnauthorizedResponseError (class)">UnauthorizedResponseError</a></span>
+    
+  
+</p>
+
+  
+    <h2>
+      Constant Summary
+      <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+    </h2>
+
+    <dl class="constants">
+      
+        <dt id="VERSION-constant" class="">VERSION =
+          <div class="docstring">
+  <div class="discussion">
+    
+<p>Holds the current version</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>version number</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div>
+        </dt>
+        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>0.1.0</span><span class='tstring_end'>&quot;</span></span></pre></dd>
+      
+    </dl>
+  
+
+
+
+
+
+
+
+  
+    <h2>
+      Class Method Summary
+      <small><a href="#" class="summary_toggle">collapse</a></small>
+    </h2>
+
+    <ul class="summary">
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#client-class_method" title="client (class method)">.<strong>client</strong>(**options)  &#x21d2; Client </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>A convenient and clearer way of getting and overriding default attribute values of the singleton `Client.instance`.</p>
+</div></span>
+  
+</li>
+
+      
+    </ul>
+  
+
+
+
+  <div id="class_method_details" class="method_details_list">
+    <h2>Class Method Details</h2>
+
+    
+      <div class="method_details first">
+  <h3 class="signature first" id="client-class_method">
+  
+    .<strong>client</strong>(**options)  &#x21d2; <tt><span class='object_link'><a href="TwelvedataRuby/Client.html" title="TwelvedataRuby::Client (class)">Client</a></span></tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>A convenient and clearer way of getting and overriding default attribute values of the singleton `Client.instance`</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>options</span>
+      
+      
+        <span class='type'>(<tt>Hash</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>the optional Hash object that may contain values to override the defaults</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+  
+    
+    
+    <p class="tag_title">Options Hash (<tt>**options</tt>):</p>
+    <ul class="option">
+      
+        <li>
+          <span class="name">:apikey</span>
+          <span class="type">(<tt>Symbol</tt>, <tt>String</tt>)</span>
+          <span class="default">
+            
+          </span>
+          
+            &mdash; <div class='inline'>
+<p>the private key from Twelvedata API key</p>
+</div>
+          
+        </li>
+      
+        <li>
+          <span class="name">:connect_timeout</span>
+          <span class="type">(<tt>Integer</tt>, <tt>String</tt>)</span>
+          <span class="default">
+            
+          </span>
+          
+            &mdash; <div class='inline'>
+<p>milliseconds</p>
+
+<p>@example Passing a nil options</p>
+
+<pre class="code ruby"><code class="ruby"><span class='const'><span class='object_link'><a href="" title="TwelvedataRuby (module)">TwelvedataRuby</a></span></span><span class='period'>.</span><span class='id identifier rubyid_client'>client</span>
+</code></pre>
+
+<p>The singleton instance  object returned will use the default values  for its attributes</p>
+
+<p>@example Passing values of `:apikey` and `:connect_timeout`</p>
+
+<pre class="code ruby"><code class="ruby"><span class='const'><span class='object_link'><a href="" title="TwelvedataRuby (module)">TwelvedataRuby</a></span></span><span class='period'>.</span><span class='id identifier rubyid_client'>client</span><span class='lparen'>(</span><span class='label'>apikey:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>my-twelvedata-apikey</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>connect_timeout:</span> <span class='int'>3000</span><span class='rparen'>)</span>
+</code></pre>
+
+<p>@example or, chain with other Client instance method</p>
+
+<pre class="code ruby"><code class="ruby"><span class='const'><span class='object_link'><a href="" title="TwelvedataRuby (module)">TwelvedataRuby</a></span></span><span class='period'>.</span><span class='id identifier rubyid_client'>client</span><span class='lparen'>(</span><span class='label'>apikey:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>my-twelvedata-apikey</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>connect_timeout:</span> <span class='int'>3000</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_quote'>quote</span><span class='lparen'>(</span><span class='label'>symbol:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>IBM</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
+</code></pre>
+
+<p>In the last example, calling `#quote`, a valid API endpoint, an instance method with the same name was dynamically defined and then fired up an API request to Twelvedata.</p>
+</div>
+          
+        </li>
+      
+    </ul>
+  
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt><span class='object_link'><a href="TwelvedataRuby/Client.html" title="TwelvedataRuby::Client (class)">Client</a></span></tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>singleton instance</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+38
+39
+40
+41
+42</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/twelvedata_ruby.rb', line 38</span>
+
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_client'>client</span><span class='lparen'>(</span><span class='op'>**</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_client'>client</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="TwelvedataRuby/Client.html" title="TwelvedataRuby::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_instance'>instance</span>
+  <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lparen'>(</span><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_options'>options</span> <span class='op'>||</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_client'>client</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+  </div>
+
+</div>
+
+      <div id="footer">
+  Generated on Tue Jul 13 08:56:48 2021 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.26 (ruby-3.0.1).
+</div>
+
+    </div>
+  </body>
+</html>