Skip to content

Commit

Permalink
Init alpharb gem.
Browse files Browse the repository at this point in the history
  • Loading branch information
hamorim committed Oct 26, 2019
0 parents commit 57ac6ad
Show file tree
Hide file tree
Showing 15 changed files with 295 additions and 0 deletions.
16 changes: 16 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
/.bundle/
/.yardoc
/_yardoc/
/coverage/
/doc/
/pkg/
/spec/reports/
/tmp/

# rspec failure tracking
.rspec_status

/spec/config.yml

*.lock
*.gem
3 changes: 3 additions & 0 deletions .rspec
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
--format documentation
--color
--require spec_helper
7 changes: 7 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
sudo: false
language: ruby
cache: bundler
rvm:
- 2.4.0
before_install: gem install bundler -v 2.0.2
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@

# CHANGELOG.md

## avantage 0.2.0 released 2019-10-26

* Initial release
74 changes: 74 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, gender identity and expression, level of experience,
nationality, personal appearance, race, religion, or sexual identity and
orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment
include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.

Project maintainers 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, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.

## Scope

This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at [email protected]. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at [http://contributor-covenant.org/version/1/4][version]

[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/
4 changes: 4 additions & 0 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
source "https://rubygems.org"

# Specify your gem's dependencies in alpharb.gemspec
gemspec
21 changes: 21 additions & 0 deletions LICENSE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2019 Hugo Lyra

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.
55 changes: 55 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# Alpharb [![Gem Version](https://badge.fury.io/rb/alpharb.svg)](https://badge.fury.io/rb/alpharb)

A Ruby library to query the [Alpha Vantage API](https://www.alphavantage.co/documentation/).

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'alpharb'
```

And then execute:

$ bundle

Or install it yourself as:

$ gem install alpharb

## Usage

```ruby
require 'alpharb'

Alpharb::Client.new('APIKEY').search('BIDI4')

{
:bestMatches=>[
{
:"1. symbol"=>"BIDI4.SAO",
:"2. name"=>"Banco Inter S.A.",
:"3. type"=>"Equity",
:"4. region"=>"Brazil/Sao Paolo",
:"5. marketOpen"=>"10:00",
:"6. marketClose"=>"17:30",
:"7. timezone"=>"UTC-03",
:"8. currency"=>"BRL",
:"9. matchScore"=>"0.7692"
}
]
}
```

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/hamorim/alpharb. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

## 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 Alpharb project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/hamorim/alpharb/blob/master/CODE_OF_CONDUCT.md).
6 changes: 6 additions & 0 deletions Rakefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
require "bundler/gem_tasks"
require "rspec/core/rake_task"

RSpec::Core::RakeTask.new(:spec)

task :default => :spec
30 changes: 30 additions & 0 deletions alpharb.gemspec
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
lib = File.expand_path("lib", __dir__)
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
require "alpharb/version"

Gem::Specification.new do |spec|
spec.name = "alpharb"
spec.version = Alpharb::VERSION
spec.authors = ["Hugo Lyra"]
spec.email = ["[email protected]"]

spec.summary = %q{AlphaRB.}
spec.description = %q{A Ruby library to query the Alpha Vantage API.}
spec.homepage = "https://github.com/hamorim/alpharb"
spec.license = "MIT"

spec.metadata["homepage_uri"] = spec.homepage

spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
`git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
end

spec.require_paths = ["lib"]

spec.add_development_dependency "bundler", "~> 2.0"
spec.add_development_dependency "rake", "~> 10.0"
spec.add_development_dependency "rspec", "~> 3.0"

spec.add_dependency "faraday", "~> 0.17.0"
spec.add_dependency "oj", "~> 3.9", ">= 3.9.2"
end
5 changes: 5 additions & 0 deletions lib/alpharb.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
require "oj"
require "faraday"
require "alpharb/version"
require "alpharb/client"

33 changes: 33 additions & 0 deletions lib/alpharb/client.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
module Alpharb
class Client
API_ENDPOINT = 'https://www.alphavantage.co'.freeze

attr_reader :token

def initialize(token = nil)
@token = token
end

def search(keywords)
request params: { function: 'SYMBOL_SEARCH', keywords: keywords }
end

def quote(symbol)
request params: { function: 'GLOBAL_QUOTE', symbol: symbol }
end

private

def client
@_client ||= Faraday.new(API_ENDPOINT) do |client|
client.request :url_encoded
client.adapter Faraday.default_adapter
end
end

def request(http_method: :get, endpoint: "query", params: {})
response = client.public_send(http_method, endpoint, params.merge(apikey: @token))
Oj.load(response.body, { symbol_keys: true })
end
end
end
3 changes: 3 additions & 0 deletions lib/alpharb/version.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
module Alpharb
VERSION = "0.2.0"
end
21 changes: 21 additions & 0 deletions spec/alpharb_spec.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
RSpec.describe Alpharb do
it "has a version number" do
expect(Alpharb::VERSION).not_to be nil
end

it "create a new client" do
client = Alpharb::Client.new key: @config["key"]
expect(client.class).to eq Alpharb::Client
end

it "search for a quote" do
result = @client.search "BIDI4"
expect(result[:bestMatches][0][:"1. symbol"]).to eq "BIDI4.SAO"
expect(result[:bestMatches][0][:"2. name"]).to eq "Banco Inter S.A."
end

it "retrieve info for a quote" do
result = @client.quote "BIDI4.SAO"
expect(result[:"Global Quote"][:"01. symbol"]).to eq "BIDI4.SAO"
end
end
11 changes: 11 additions & 0 deletions spec/spec_helper.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
require "bundler/setup"
require "yaml"
require "alpharb"

RSpec.configure do |config|
config.color = true
config.before(:all) do
@config = YAML::load_file(File.join(__dir__, 'config.yml'))
@client = Alpharb::Client.new @config["key"]
end
end

0 comments on commit 57ac6ad

Please sign in to comment.