fxdatapi 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8b5475835675e4a36cb74bc6f5c5758297908f85ed3c75918fff906c9b96bd6c
+  data.tar.gz: 0e10dd7bc8610fb91fd21c7615c0b29e79fb31f438a92f1b5b8feb69dd57b140
+SHA512:
+  metadata.gz: 8bda9fb978d393bd86245e9b47ff478a89c2afc502aa82ff845ccc9adefac16417ca1bd894089db86ffa32bfd4158f642fdb2f8a1679f3b200cb034450cd8601
+  data.tar.gz: 335485f526dbe4d88bd3a75207aba6688b6ec11c360055d71d8d955049a34bbe62dd43d50c92da2ff7fb7e0c0ad8eee687995cf7ad87882921e27468e860548d

data/.rspec

@@ -0,0 +1 @@
+--colour

data/.rubocop.yml

@@ -0,0 +1,16 @@
+---
+inherit_from:
+  - .rubocop_todo.yml
+  - .rubocop_fxdatapi.yml
+
+require:
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 3.0
+  Exclude:
+    - '*.gemspec'
+    - 'Rakefile'
+    - 'vendor/**/*'

data/.rubocop_currensees.yml

@@ -0,0 +1,390 @@
+---
+# Defaults https://github.com/bbatsov/rubocop/blob/master/config/default.yml
+#
+# References:
+#  * https://github.com/bbatsov/ruby-style-guide
+#  * https://rubocop.readthedocs.io/
+
+AllCops:
+  Exclude:
+    # Exclude .gemspec files because they are generally auto-generated
+    - '*.gemspec'
+  NewCops: enable
+
+# In most cases, Gems are sorted alphabetically.
+# However, in some few cases the order is relevant due to dependencies.
+Bundler/OrderedGems:
+  Enabled: false
+
+# This cop requires odd code indentations (as of rubocop 0.57.0)
+# https://github.com/rubocop-hq/rubocop/issues/5956
+Layout/AccessModifierIndentation:
+  Enabled: false
+
+# It causes weird aligments, especially for specs.
+Layout/BlockEndNewline:
+  Enabled: false
+
+# Generally, the keyword style uses a lot of space. This is particularly true
+# when you use case/if statements, in combination with a long-name variable.
+#
+#   invoice_error_message = case error
+#                           when 1 == 1
+#                             do_something
+#                           else
+#                             do_else
+#                           end
+#
+Layout/EndAlignment:
+  EnforcedStyleAlignWith: variable
+
+# [codesmell]
+Layout/LineLength:
+  Enabled: false
+  Exclude:
+    - 'spec/**/*_spec.rb'
+    - 'test/**/*_test.rb'
+  Max: 100
+
+# [codesmell]
+Lint/SuppressedException:
+  Enabled: false
+
+# [codesmell]
+Metrics/AbcSize:
+  Enabled: false
+  Exclude:
+    - 'spec/**/*_spec.rb'
+    - 'test/**/*_test.rb'
+
+# [codesmell]
+Metrics/BlockLength:
+  Enabled: false
+
+# [codesmell]
+Metrics/CyclomaticComplexity:
+  Enabled: false
+  Exclude:
+    - 'spec/**/*_spec.rb'
+    - 'test/**/*_test.rb'
+
+# [codesmell]
+Metrics/ClassLength:
+  Enabled: false
+  Exclude:
+    - 'spec/**/*_spec.rb'
+    - 'test/**/*_test.rb'
+
+# [codesmell]
+Metrics/MethodLength:
+  Enabled: false
+  Exclude:
+    - 'spec/**/*_spec.rb'
+    - 'test/**/*_test.rb'
+  Max: 10
+
+# [codesmell]
+Metrics/ModuleLength:
+  Enabled: false
+  Exclude:
+    - 'spec/**/*_spec.rb'
+    - 'test/**/*_test.rb'
+
+# [codesmell]
+Metrics/ParameterLists:
+  Enabled: false
+  Max: 5
+
+# [codesmell]
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+# We tend to use @_name to represent a variable that is memoized,
+# but it should not be accessed directly and kept as private.
+Naming/MemoizedInstanceVariableName:
+  Enabled: false
+
+# We use it from time to time, as it's not always possible (or maintainable)
+# to use simple ? methods.
+# Moreover, it's actually more efficient to not-use predicates:
+# https://github.com/bbatsov/rubocop/issues/3633
+Naming/PredicateName:
+  Enabled: false
+
+# The team agreed decided to use exception
+Naming/RescuedExceptionsVariableName:
+  PreferredName: 'exception'
+
+# This cop triggers several false positives that make sense in our domain model.
+# For instance, ip is considered an uncommunicative parameter name:
+#
+#   ipv4_to_arpa_name(ip)
+#
+Naming/MethodParameterName:
+  Enabled: false
+
+# This cop returns false positive violations (as of rubocop 0.57.0)
+# https://github.com/rubocop-hq/rubocop/issues/5953
+Style/AccessModifierDeclarations:
+  Enabled: false
+
+# Do not use "and" or "or" in conditionals, but for readability we can use it
+# to chain executions. Just beware of operator order.
+Style/AndOr:
+  EnforcedStyle: conditionals
+
+# No specific reason, except that %q() is easier to grep than %()
+Style/BarePercentLiterals:
+  EnforcedStyle: percent_q
+
+# braces_for_chaining seems a good fit of what we've been doing so far.
+Style/BlockDelimiters:
+  EnforcedStyle: braces_for_chaining
+  AllowedMethods:
+    - expect
+
+# Warn on empty else.
+Style/EmptyElse:
+  EnforcedStyle: empty
+
+# There is no specific preference for empty methods.
+# One-line methods are not exceptionally nice in Ruby.
+# Just ignore this cop for now.
+Style/EmptyMethod:
+  Enabled: false
+
+# We don't care about the format style.
+# In most cases we use %, but not at the point we want to enforce it
+# as a convention in the entire code.
+Style/FormatString:
+  Enabled: false
+
+# Annotated tokens (like %<foo>s) are a good thing,
+# but in most cases we don't need them.
+# %s is a simpler and straightforward version that works in almost all cases.
+# So don't complain.
+Style/FormatStringToken:
+  Enabled: false
+
+# Prefer the latest Hash syntax
+Style/HashSyntax:
+  Exclude:
+    # Rakefiles generally have definitions like
+    #   :default => :test
+    # that looks nicer with the old rocket syntax.
+    - 'Rakefile'
+
+# Enforces usage of Hash#each_key and Hash#each_value (vs. Hash#keys.each
+# and Hash#values.each).
+Style/HashEachMethods:
+  Enabled: true
+
+# Enforce the use of Hash#TransformKeys introduced in Ruby 2.5 to transform
+# Hash keys.
+Style/HashTransformKeys:
+  Enabled: true
+
+# Enforce the use of Hash#TransformValues introduced in Ruby 2.5 to transform
+# Hash values.
+Style/HashTransformValues:
+  Enabled: true
+
+# We want to be able to decide when to use one-line if/unless modifiers.
+Style/IfUnlessModifier:
+  Enabled: false
+
+# [codesmell]
+# It's not always that bad.
+Style/IfInsideElse:
+  Enabled: false
+
+# module_function doesn't respect the visibility of the methods,
+# and doesn't work well when the module contains both public/private methods.
+Style/ModuleFunction:
+  Enabled: false
+
+Style/MultilineBlockChain:
+  Exclude:
+    # RSpec uses multi-line blocks for certain features
+    - 'spec/**/*_spec.rb'
+
+# unless is not always cool.
+Style/NegatedIf:
+  Enabled: false
+
+# Magic numbers are not welcomed
+Style/NumericLiterals:
+  Exclude:
+    # however tests can use numeric literals for method calls,
+    # without the need to define a variable just for that.
+    - 'spec/**/*_spec.rb'
+    - 'test/**/*_test.rb'
+
+# For years, %w() has been the de-facto standard.
+# A lot of libraries are using (). Switching to [] would be a nightmare.
+Style/PercentLiteralDelimiters:
+  Enabled: false
+
+# Enable but only for multiple returns value.
+#
+#   return foo, bar
+#
+# reads much better than
+#
+#   [foo, bar]
+#
+Style/RedundantReturn:
+  AllowMultipleReturnValues: true
+
+# Do we care?
+Style/RegexpLiteral:
+  Enabled: false
+
+# There are cases were the inline rescue is ok. We can either downgrade
+# the severity, or rely on the developer judgement on a case-by-case basis.
+Style/RescueModifier:
+  Enabled: false
+
+# This is quite annoying, especially in cases where we don't control it
+# (e.g. schema.rb).
+Style/SymbolArray:
+  Enabled: false
+
+# We don't have a preference.
+Style/SpecialGlobalVars:
+  Enabled: false
+  EnforcedStyle: use_perl_names
+
+# We generally use double quotes, sometimes single quotes.
+# Should we enforce it at code level?
+Style/StringLiterals:
+  Enabled: false
+  EnforcedStyle: double_quotes
+
+# As before.
+Style/StringLiteralsInInterpolation:
+  Enabled: false
+  EnforcedStyle: double_quotes
+
+# It's nice to be consistent. The trailing comma also allows easy reordering,
+# and doesn't cause a diff in Git when you add a line to the bottom.
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+
+# It's nice to be consistent. The trailing comma also allows easy reordering,
+# and doesn't cause a diff in Git when you add a line to the bottom.
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrivialAccessors:
+  # IgnoreClassMethods because I want to be able to define class-level accessors
+  # that sets an instance variable on the metaclass, such as:
+  #
+  #    def self.default=(value)
+  #      @default = value
+  #    end
+  #
+  IgnoreClassMethods: true
+
+Style/WordArray:
+  EnforcedStyle: percent
+  MinSize: 3
+
+# Forces the order of comparison arguments.
+#
+# According to this cop, the following statement is bad:
+#
+#   "https" == uri.scheme
+#
+# Whereas the following is considered good:
+#
+#   uri.scheme == "https"
+Style/YodaCondition:
+  Enabled: false
+
+# For the same reason of EndAlignment, aligning with the case may have
+# a bad impact on a case after a very long variable.
+#
+#   invoice_error_message = case error
+#                           when 1 == 1
+#                             do_something
+#                           else
+#                             do_else
+#                           end
+#
+Layout/CaseIndentation:
+  EnforcedStyle: end
+
+# I was a big fan of leading, but trailing seems to be more commonly adopted.
+# At least at the time being.
+Layout/DotPosition:
+  EnforcedStyle: leading
+
+# Double empty lines are useful to separate conceptually different methods
+# in the same class or module.
+Layout/EmptyLines:
+  Enabled: false
+
+# This is buggy. It detects as a style violation a few `class`
+# and `module` definitions
+Layout/EmptyLinesAroundArguments:
+  Enabled: false
+
+Layout/EmptyLinesAroundBlockBody:
+  Exclude:
+    # RSpec is all made of blocks. Disable this config in RSpec
+    # to be consistent with EmptyLinesAroundClassBody
+    # and EmptyLinesAroundModuleBody
+    - 'spec/**/*_spec.rb'
+    - 'test/**/*_test.rb'
+
+# In most cases, a space is nice. Sometimes, it's not.
+# Just be consistent with the rest of the surrounding code.
+Layout/EmptyLinesAroundClassBody:
+  Enabled: false
+
+# We're ok with it. We use it quite often for method-level rescue statements.
+Layout/EmptyLinesAroundExceptionHandlingKeywords:
+  Enabled: false
+
+# In most cases, a space is nice. Sometimes, it's not.
+# Just be consistent with the rest of the surrounding code.
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: false
+
+# This is quite buggy, as it doesn't recognize double lines.
+Layout/EmptyLineBetweenDefs:
+  Enabled: false
+
+# Multi-line differs from standard indentation, they are indented twice.
+Layout/FirstArgumentIndentation:
+  IndentationWidth: 4
+
+# Array indentation should be consistent with method/variable definition.
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: consistent
+
+# Hash indentation should be consistent with method/variable definition.
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
+
+# Multi-line differs from standard indentation, they are indented twice.
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+  IndentationWidth: 4
+
+# Multi-line differs from standard indentation, they are indented twice.
+Layout/MultilineOperationIndentation:
+  EnforcedStyle: indented
+  IndentationWidth: 4
+
+# Sorry, but using trailing spaces helps readability.
+#
+#   %w( foo bar )
+#
+# looks better than:
+#
+#   %w(foo bar)
+#
+Layout/SpaceInsidePercentLiteralDelimiters:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,45 @@
+# Offense count: 74
+# Configuration parameters: CountAsOne.
+RSpec/ExampleLength:
+  Max: 17
+
+# Offense count: 1
+RSpec/LeakyConstantDeclaration:
+  Exclude:
+    - 'lib/fxdatapi/auth.rb'
+
+# Offense count: 12
+# Configuration parameters: .
+# SupportedStyles: have_received, receive
+RSpec/MessageSpies:
+  EnforcedStyle: receive
+
+# Offense count: 115
+RSpec/MultipleExpectations:
+  Max: 15
+
+# Offense count: 372
+# Configuration parameters: EnforcedStyle, IgnoreSharedExamples.
+# SupportedStyles: always, named_only
+RSpec/NamedSubject:
+  Enabled: false
+
+# Offense count: 16
+RSpec/SubjectStub:
+  Exclude:
+    - 'lib/fxdatapi/convert_all.rb'
+    - 'lib/fxdatapi/convert.rb'
+    - 'lib/fxdatapi/currencies.rb'
+    - 'lib/fxdatapi/daily_average.rb'
+    - 'lib/fxdatapi/historical.rb'
+    - 'lib/fxdatapi/margins_spreads.rb'
+    - 'lib/fxdatapi/performances.rb'
+    - 'lib/fxdatapi/signals.rb'
+    - 'lib/fxdatapi/version.rb'
+    - 'lib/fxdatapi/weekly_average.rb'
+    - 'lib/fxdatapi/monthly_average.rb'
+
+# Offense count: 69
+# Configuration parameters: AllowedConstants.
+Style/Documentation:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# 0.1.2 (May 10, 2023)
+
+* Tweaks.
+
+# 0.1.1 (May 02, 2023)
+
+* Monthly Average added.
+
+# 0.1.0 (April 28, 2023)
+
+* Initial release.

data/CODEOWNERS

@@ -0,0 +1,2 @@
+@0xnu
+@moatsystems

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 f@finbarrs.eu. 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/CONTRIBUTORS

@@ -0,0 +1 @@
+Finbarrs Oketunji <f@finbarrs.eu>

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in fxdatapi.gemspec
+gemspec
+
+gem 'yard'
+gem "rake", "~> 13.0"
+gem 'coveralls', require: false
+gem 'rubocop', '1.48.0', require: false
+gem 'rubocop-performance', '1.16.0', require: false
+gem 'rubocop-rake', '0.6.0', require: false
+gem 'rubocop-rspec', '2.19.0', require: false

data/Gemfile.lock

@@ -0,0 +1,76 @@
+PATH
+  remote: .
+  specs:
+    fxdatapi (0.1.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    coveralls (0.8.23)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.16.1)
+      term-ansicolor (~> 1.3)
+      thor (>= 0.19.4, < 2.0)
+      tins (~> 1.6)
+    docile (1.4.0)
+    json (2.6.3)
+    parallel (1.23.0)
+    parser (3.2.2.1)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.0)
+    rexml (3.2.5)
+    rubocop (1.48.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.26.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.28.1)
+      parser (>= 3.2.1.0)
+    rubocop-capybara (2.18.0)
+      rubocop (~> 1.41)
+    rubocop-performance (1.16.0)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.19.0)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
+    ruby-progressbar (1.13.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    sync (0.5.0)
+    term-ansicolor (1.7.1)
+      tins (~> 1.0)
+    thor (1.2.1)
+    tins (1.32.1)
+      sync
+    unicode-display_width (2.4.2)
+    yard (0.9.34)
+
+PLATFORMS
+  x86_64-darwin-21
+
+DEPENDENCIES
+  coveralls
+  fxdatapi!
+  rake (~> 13.0)
+  rubocop (= 1.48.0)
+  rubocop-performance (= 1.16.0)
+  rubocop-rake (= 0.6.0)
+  rubocop-rspec (= 2.19.0)
+  yard
+
+BUNDLED WITH
+   2.4.12

data/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2023, Moat Systems Limited. All Rights Reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.