twelvedata_ruby 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 875e9a7aa6d49ba856df319540c987e48ac4fd04ab8cf10f80d804ac685b27c0
-  data.tar.gz: 3db748bb0a8945897b87748bd49705a9e435523f71c9c572eadd38363ff5b044
+  metadata.gz: bca739fd82cc17f890fa3793d8125fcb31e1c553f6c2303d056f4a1a64ac6610
+  data.tar.gz: 54813515e1e086fe341ffeb4a08502843e1c0ae0f4239dd890e55570381c9fd2
 SHA512:
-  metadata.gz: da38162ec79f04bd05c69baa4ee8aa26c2419f557503fe6850f7babd3b10125536bc54e444000a8a8876ea99c754f38b195b6f5227130081f258945ef0bae7c5
-  data.tar.gz: a3bb92af00adeff804939396c2423a087bccfde71c12905b2a5e047aa4d93c5b446eed6ae123310490e7b9aacd23f6beaa2d5fa7314304a33163ff6d03a35f58
+  metadata.gz: a3e77b8dafd422258e5dee1ddf68f8c48595ead5758bf3b6e084b125bf14f2b5c54091c7464b9b6a152aec4696bf1f48199e7ffb72318e67784693b469446d41
+  data.tar.gz: 06c8fe4b17c366881fc4555d697ac276e9dc8e3956dfd6dabe5aea473e91d58a1044f5af51773586fbe3900baca8ac08fdb1436c1e9fb075768becfb9d95be3e

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    twelvedata_ruby (0.1.1)
+    twelvedata_ruby (0.2.0)
       httpx (~> 0.14.5)
 
 GEM

data/README.md

@@ -105,8 +105,37 @@ resp_objects_array = TwelvedataRuby::Client.request(quote_req, timeseries_req, e
 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
+The data from a successful API request can be access from `Response#parsed_body`. If request format is `:json` then it will be a `Hash` instance
 
+```ruby
+TwelvedataRuby.client.quote(symbol: "GOOG").parsed_body
+=>
+{:symbol=>"GOOG",
+ :name=>"Alphabet Inc",
+ :exchange=>"NASDAQ",
+ :currency=>"USD",
+ :datetime=>"2021-07-15",
+ :open=>"2650.00000",
+ :high=>"2651.89990",
+ :low=>"2611.95996",
+ :close=>"2625.33008",
+ :volume=>"828300",
+ :previous_close=>"2641.64990",
+ :change=>"-16.31982",
+ :percent_change=>"-0.61779",
+ :average_volume=>"850344",
+ :fifty_two_week=>{:low=>"1406.55005", :high=>"2659.91992", :low_change=>"1218.78003", :high_change=>"-34.58984", :low_change_percent=>"86.65031", :high_change_percent=>"-1.30041", :range=>"1406.550049 - 2659.919922"}}
+```
+
+Likewise, if the API request format is `:csv` then `Response#parsed_body` will be `CSV#Table` instance
+
+```ruby
+TwelvedataRuby.client.quote(symbol: "GOOG", format: :csv).parsed_body
+=> #<CSV::Table mode:col_or_row row_count:2>
+```
+
+## Documentation
+You can browse the source code [documentation](https://kanroyalhigh.github.io/twelvedata_ruby/doc/)
 ## 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).

data/doc/TwelvedataRuby.html

@@ -149,7 +149,7 @@
 
 </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>
+        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>0.1.1</span><span class='tstring_end'>&quot;</span></span></pre></dd>
       
     </dl>
   
@@ -343,7 +343,7 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Jul 13 08:56:48 2021 by
+  Generated on Fri Jul 16 20:51:23 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>

data/doc/TwelvedataRuby/BadRequestResponseError.html

@@ -168,7 +168,7 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Jul 13 08:56:50 2021 by
+  Generated on Fri Jul 16 20:51:24 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>

data/doc/TwelvedataRuby/Client.html

@@ -1433,7 +1433,7 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Jul 13 08:56:52 2021 by
+  Generated on Fri Jul 16 20:51:25 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>

data/doc/TwelvedataRuby/Endpoint.html

@@ -1468,7 +1468,7 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Jul 13 08:56:54 2021 by
+  Generated on Fri Jul 16 20:51:25 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>

data/doc/TwelvedataRuby/EndpointError.html

@@ -237,7 +237,7 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Jul 13 08:56:49 2021 by
+  Generated on Fri Jul 16 20:51:23 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>

data/doc/TwelvedataRuby/EndpointNameError.html

@@ -157,7 +157,7 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Jul 13 08:56:49 2021 by
+  Generated on Fri Jul 16 20:51:23 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>

data/doc/TwelvedataRuby/EndpointParametersKeysError.html

@@ -157,7 +157,7 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Jul 13 08:56:49 2021 by
+  Generated on Fri Jul 16 20:51:23 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>

data/doc/TwelvedataRuby/EndpointRequiredParametersError.html

@@ -157,7 +157,7 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Jul 13 08:56:49 2021 by
+  Generated on Fri Jul 16 20:51:24 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>

data/doc/TwelvedataRuby/Error.html

@@ -308,7 +308,7 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Jul 13 08:56:48 2021 by
+  Generated on Fri Jul 16 20:51:23 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>

data/doc/TwelvedataRuby/ForbiddenResponseError.html

@@ -168,7 +168,7 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Jul 13 08:56:50 2021 by
+  Generated on Fri Jul 16 20:51:24 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>

data/doc/TwelvedataRuby/InternalServerResponseErro.html

@@ -168,7 +168,7 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Jul 13 08:56:51 2021 by
+  Generated on Fri Jul 16 20:51:24 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>

data/doc/TwelvedataRuby/NotFoundResponseError.html

@@ -168,7 +168,7 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Jul 13 08:56:50 2021 by
+  Generated on Fri Jul 16 20:51:24 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>

data/doc/TwelvedataRuby/PageNotFoundResponseError.html

@@ -168,7 +168,7 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Jul 13 08:56:51 2021 by
+  Generated on Fri Jul 16 20:51:24 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>

data/doc/TwelvedataRuby/ParameterTooLongResponseError.html

@@ -168,7 +168,7 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Jul 13 08:56:51 2021 by
+  Generated on Fri Jul 16 20:51:24 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>

data/doc/TwelvedataRuby/Request.html

@@ -673,7 +673,7 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Jul 13 08:56:53 2021 by
+  Generated on Fri Jul 16 20:51:25 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>

data/doc/TwelvedataRuby/Response.html

@@ -1612,7 +1612,7 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Jul 13 08:56:55 2021 by
+  Generated on Fri Jul 16 20:51:26 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>

data/doc/TwelvedataRuby/ResponseError.html

@@ -555,7 +555,7 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Jul 13 08:56:50 2021 by
+  Generated on Fri Jul 16 20:51:24 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>

data/doc/TwelvedataRuby/TooManyRequestsResponseError.html

@@ -168,7 +168,7 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Jul 13 08:56:51 2021 by
+  Generated on Fri Jul 16 20:51:24 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>

data/doc/TwelvedataRuby/UnauthorizedResponseError.html

@@ -168,7 +168,7 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Jul 13 08:56:50 2021 by
+  Generated on Fri Jul 16 20:51:24 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>

data/doc/TwelvedataRuby/Utils.html

@@ -493,7 +493,7 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Jul 13 08:56:48 2021 by
+  Generated on Fri Jul 16 20:51:23 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>

data/doc/_index.html

@@ -305,7 +305,7 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Jul 13 08:56:45 2021 by
+  Generated on Fri Jul 16 20:51:22 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>

data/doc/file.README.html

@@ -164,9 +164,38 @@ resp_objects_array = TwelvedataRuby::Client.request(quote_req, timeseries_req, e
 
 <p>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. :)</p>
 
-<p>TODO: write more documenation especially the response object</p>
+<p>The data from a successful API request can be access from <code>Response#parsed_body</code>. If request format is <code>:json</code> then it will be a <code>Hash</code> instance</p>
 
-<h2 id="contributing">Contributing</h2>
+<p><code>ruby
+TwelvedataRuby.client.quote(symbol: "GOOG").parsed_body
+=&gt;
+{:symbol=&gt;"GOOG",
+ :name=&gt;"Alphabet Inc",
+ :exchange=&gt;"NASDAQ",
+ :currency=&gt;"USD",
+ :datetime=&gt;"2021-07-15",
+ :open=&gt;"2650.00000",
+ :high=&gt;"2651.89990",
+ :low=&gt;"2611.95996",
+ :close=&gt;"2625.33008",
+ :volume=&gt;"828300",
+ :previous_close=&gt;"2641.64990",
+ :change=&gt;"-16.31982",
+ :percent_change=&gt;"-0.61779",
+ :average_volume=&gt;"850344",
+ :fifty_two_week=&gt;{:low=&gt;"1406.55005", :high=&gt;"2659.91992", :low_change=&gt;"1218.78003", :high_change=&gt;"-34.58984", :low_change_percent=&gt;"86.65031", :high_change_percent=&gt;"-1.30041", :range=&gt;"1406.550049 - 2659.919922"}}
+</code></p>
+
+<p>Likewise, if the API request format is <code>:csv</code> then <code>Response#parsed_body</code> will be <code>CSV#Table</code> instance</p>
+
+<p><code>ruby
+TwelvedataRuby.client.quote(symbol: "GOOG", format: :csv).parsed_body
+=&gt; #&lt;CSV::Table mode:col_or_row row_count:2&gt;
+</code></p>
+
+<h2 id="documentation">Documentation</h2>
+<p>You can browse the source code <a href="https://kanroyalhigh.github.io/twelvedata_ruby/doc/">documentation</a>
+## Contributing</p>
 
 <p>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 <a href="https://github.com/[USERNAME]/twelvedata_ruby/blob/master/CODE_OF_CONDUCT.md">code of conduct</a>.</p>
 
@@ -184,7 +213,7 @@ resp_objects_array = TwelvedataRuby::Client.request(quote_req, timeseries_req, e
 </div></div>
 
       <div id="footer">
-  Generated on Tue Jul 13 08:56:46 2021 by
+  Generated on Fri Jul 16 20:51:22 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>

data/doc/index.html

@@ -164,9 +164,38 @@ resp_objects_array = TwelvedataRuby::Client.request(quote_req, timeseries_req, e
 
 <p>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. :)</p>
 
-<p>TODO: write more documenation especially the response object</p>
+<p>The data from a successful API request can be access from <code>Response#parsed_body</code>. If request format is <code>:json</code> then it will be a <code>Hash</code> instance</p>
 
-<h2 id="contributing">Contributing</h2>
+<p><code>ruby
+TwelvedataRuby.client.quote(symbol: "GOOG").parsed_body
+=&gt;
+{:symbol=&gt;"GOOG",
+ :name=&gt;"Alphabet Inc",
+ :exchange=&gt;"NASDAQ",
+ :currency=&gt;"USD",
+ :datetime=&gt;"2021-07-15",
+ :open=&gt;"2650.00000",
+ :high=&gt;"2651.89990",
+ :low=&gt;"2611.95996",
+ :close=&gt;"2625.33008",
+ :volume=&gt;"828300",
+ :previous_close=&gt;"2641.64990",
+ :change=&gt;"-16.31982",
+ :percent_change=&gt;"-0.61779",
+ :average_volume=&gt;"850344",
+ :fifty_two_week=&gt;{:low=&gt;"1406.55005", :high=&gt;"2659.91992", :low_change=&gt;"1218.78003", :high_change=&gt;"-34.58984", :low_change_percent=&gt;"86.65031", :high_change_percent=&gt;"-1.30041", :range=&gt;"1406.550049 - 2659.919922"}}
+</code></p>
+
+<p>Likewise, if the API request format is <code>:csv</code> then <code>Response#parsed_body</code> will be <code>CSV#Table</code> instance</p>
+
+<p><code>ruby
+TwelvedataRuby.client.quote(symbol: "GOOG", format: :csv).parsed_body
+=&gt; #&lt;CSV::Table mode:col_or_row row_count:2&gt;
+</code></p>
+
+<h2 id="documentation">Documentation</h2>
+<p>You can browse the source code <a href="https://kanroyalhigh.github.io/twelvedata_ruby/doc/">documentation</a>
+## Contributing</p>
 
 <p>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 <a href="https://github.com/[USERNAME]/twelvedata_ruby/blob/master/CODE_OF_CONDUCT.md">code of conduct</a>.</p>
 
@@ -184,7 +213,7 @@ resp_objects_array = TwelvedataRuby::Client.request(quote_req, timeseries_req, e
 </div></div>
 
       <div id="footer">
-  Generated on Tue Jul 13 08:56:46 2021 by
+  Generated on Fri Jul 16 20:51:22 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>

data/doc/top-level-namespace.html

@@ -100,7 +100,7 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Jul 13 08:56:46 2021 by
+  Generated on Fri Jul 16 20:51:23 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>

data/lib/twelvedata_ruby.rb

@@ -12,7 +12,7 @@ require_relative "twelvedata_ruby/client"
 module TwelvedataRuby
   # Holds the current version
   # @return [String] version number
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 
   # A convenient and clearer way of getting and overriding default attribute values of the singleton `Client.instance`
   #

data/twelvedata_ruby.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.summary = "A Ruby client library that provides helping hands in accessing Twelve Data API's stock, \
                  forex, crypto, and other financial data"
   spec.description = "A Ruby gem for accessing Twelve Data's API."
-  spec.homepage = "https://github.com/kanroyalhigh/twelvedata_ruby"
+  spec.homepage = "https://kanroyalhigh.github.io/twelvedata_ruby"
   spec.license = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twelvedata_ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Kendo Camajalan, KCD
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-07-13 00:00:00.000000000 Z
+date: 2021-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpx
@@ -171,11 +171,11 @@ files:
 - lib/twelvedata_ruby/response.rb
 - lib/twelvedata_ruby/utils.rb
 - twelvedata_ruby.gemspec
-homepage: https://github.com/kanroyalhigh/twelvedata_ruby
+homepage: https://kanroyalhigh.github.io/twelvedata_ruby
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/kanroyalhigh/twelvedata_ruby
+  homepage_uri: https://kanroyalhigh.github.io/twelvedata_ruby
   source_code_uri: https://github.com/kanroyalhigh/twelvedata_ruby
   changelog_uri: https://github.com/kanroyalhigh/twelvedata_ruby/CHANGELOG.md
 post_install_message: