bloomberg_currency 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0f537c2ce326a9b6ea8dbb464eb3d8941634f174
-  data.tar.gz: 881ac7365063871ef8768566317a0834860d95f0
+  metadata.gz: 5750a9ea831b7ce49a0e34ea6f50dd02e055a84c
+  data.tar.gz: d8d18e027f2fb8af17eecb69272e7eba0db81dab
 SHA512:
-  metadata.gz: d1e4c3cdf6d7c83cb1c46b6344821887b5a3ed95a378404315c7a2a81929de71f81dbb3e2912ad63c6f36ec931c62229a1e0a7930af980588ab1c45f7879bc7d
-  data.tar.gz: 99ad8a6a0eacfc9438766833f2710bbf74fc142bff96bacac4172065d0682c9c0bcb28ef1ab2dfb7b401816f6deaf18841903a042c6a55692eaf89c4169b2c7d
+  metadata.gz: fae8f01e406f1ad92d792eaa7a3e4bc90faa3f39b75cace02be43b9fd1226c9c9b2e71e7ac5eb16b1730c1c4687839f79d869f9cde3b1fa7c449a00911a7db1b
+  data.tar.gz: fa004d8549d9606417bc50b3d5230ac8eeabf7897e3f49750bd9febaa98980831ee57a059560ffa40db49cc7e9cf10bf7bc6d4f289ae93faaff816eb7e45111f

data/.gitignore

@@ -9,4 +9,9 @@
 /tmp/
 
 # CodeClimate Coverage Reporter
-codeclimate-coverage-reporter.sh
+codeclimate-coverage-reporter.sh
+
+.DS_Store
+*/**/.DS_Store
+
+.byebug_history

data/README.md

@@ -2,7 +2,7 @@
 
 [![Build Status](https://travis-ci.org/sebasjimenez10/bloomberg_currency.svg?branch=master)](https://travis-ci.org/sebasjimenez10/bloomberg_currency) [![Code Climate](https://codeclimate.com/github/sebasjimenez10/bloomberg_currency/badges/gpa.svg)](https://codeclimate.com/github/sebasjimenez10/bloomberg_currency) [![Test Coverage](https://codeclimate.com/github/sebasjimenez10/bloomberg_currency/badges/coverage.svg)](https://codeclimate.com/github/sebasjimenez10/bloomberg_currency/coverage) [![Issue Count](https://codeclimate.com/github/sebasjimenez10/bloomberg_currency/badges/issue_count.svg)](https://codeclimate.com/github/sebasjimenez10/bloomberg_currency)
 
-Bloomberg Currency provides an easy-to-use API to pull currency exchange rates from the Bloomberg sites. If you would like to test out this gem before including it into your project, feel free to clone it, bundle it and run `bin/console` for an interactive prompt.
+Bloomberg Currency provides an easy-to-use API to pull currency exchange rates from the Bloomberg site. If you would like to test out this gem before including it into your project, feel free to clone it, bundle it and run `bin/console` for an interactive prompt.
 
 ## Installation
 
@@ -22,19 +22,57 @@ Or install it yourself as:
 
 ## Usage
 
-You just basically need to create a new instance of the Site object and then call the `quote` method on it, passing the `<currency_from>` and `<currency_to>` as parameters. Like this:
+*NOTE*: From version `0.1.0` to `1.0.0` there are mayor breaking changes. Please make sure you read the docs before installing/upgrading to the newest version.
 
+The gem usability has been improved in version 1.0. Now you only need to create an instance of the class `BC::Quote`, passing the two currencies you'd like to get information about, like this:
+
+```
+quote = BC::Quote.new('USD', 'EUR')
+=> #<BC::Quote:0x007fe92c297670 @price=0.8156, @datetime=#<DateTime: 2018-01-16T17:13:00-05:00 ((2458135j,79980s,0n),-18000s,2299161j)>, @detail=#<BC::QuoteDetail:0x007fe92c3ae8d8 @open=0.8157, @day_range=0.8156..0.8159, @previous_close=0.8157, @last_52_weeks_range=0.8133..0.9529, @ytd_return=-2.14>, @available=true>
 ```
-site = BloombergCurrency::API::Site.new
-site.quote 'USD', 'EUR'
-# => => #<BloombergCurrency::Models::Quote:0x007fdb95161098 @price=#<BigDecimal:7fdb95189930,'0.921E0',9(18)>, @price_datetime=#<DateTime: 2016-11-11T16:47:00-05:00 ((2457704j,78420s,0n),-18000s,2299161j)>, @quote_details={:open=>"0.9180", :day_range=>"0.9156 - 0.9233", :previous_close=>"0.9180", :"52wk_range"=>"0.8612 - 0.9496", :ytd_return=>"0.10%"}>
+
+Then the quote object offers a few accessor methods:
+
+- `price`: Returns a float price
+- `datetime`: Returns the date time when the price was captured
+- `detail`: Returns an object of the class BC::QuoteDetail which encapsulate the details of the quote. Will be explained later on.
+- `available?`: Return true or false if the exchange is available or not.
+
+
+The `BC::QuoteDetail` class offers the following methods:
+
+- `open`: Returns the value in which the currency opened.
+- `day_range`: Returns the day range up until the moment the quote is generated.
+- `previous_close`: Returns the value where the exchange closed last day.
+- `last_52_weeks_range`: Returns the range od the last 52 weeks.
+- `ytd_return`: Returns the YTD percentage.
+
+
+*NOTE*: When the some of the markets close, the `open` and `day_range` attributes on the Bloomberg site aren't displayed. So those attributes may not be present if the market is closed. But the quote may still be available.
+
+## Examples
+
+Getting information about the USD and EUR exchange:
+
+```
+quote = BC::Quote.new('USD', 'EUR')
+quote.price
+=> 0.8147
+
+quote.datetime
+=> #<DateTime: 2018-01-16T14:35:00-05:00 ((2458135j,70500s,0n),-18000s,2299161j)>
+
+quote.detail
+=> #<BC::QuoteDetail:0x007faadd9fb868 @open=0.8154, @day_range=0.8143..0.8199, @previous_close=0.8154, @last_52_weeks_range=0.8133..0.9529, @ytd_return=-1.91>
+
+quote.available?
+=> true
+
 ```
-As you could notice it will return a Quote object. This object contains three main attributes: `price`, `price_datetime` and `quote_details`.
-Out of those three attributes, the `quote_details` attribute contains a hash, here's an example: `{:open=>"0.9180", :day_range=>"0.9156 - 0.9233", :previous_close=>"0.9180", :"52wk_range"=>"0.8612 - 0.9496", :ytd_return=>"0.10%"}`
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rspec spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`.
 

data/Rakefile

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 

data/bloomberg_currency.gemspec

@@ -7,7 +7,7 @@ require 'bloomberg_currency/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'bloomberg_currency'
-  spec.version       = BloombergCurrency::VERSION
+  spec.version       = BC::VERSION
   spec.authors       = ['Sebastian Jimenez Velez']
   spec.email         = ['sebasjimenezv@gmail.com']
 
@@ -37,7 +37,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'simplecov', '~> 0.11'
-  spec.add_development_dependency 'nokogiri', '~> 1.6', '>= 1.6.8'
-  spec.add_development_dependency 'rubocop', '~> 0.45.0'
-  spec.add_development_dependency 'codeclimate-test-reporter', '~> 1.0.0'
+  spec.add_development_dependency 'rubocop', '~> 0.49.0'
+  spec.add_development_dependency 'codeclimate-test-reporter', '~> 1.0', '>= 1.0.0'
+  spec.add_development_dependency 'pry-byebug', '~> 3.5.1'
+
+  spec.add_runtime_dependency 'nokogiri', '~> 1.6', '>= 1.6.8'
 end

data/lib/bloomberg_currency.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
+
 require 'bloomberg_currency/version'
 require 'bloomberg_currency/api/site'
 require 'bloomberg_currency/api/host'
-require 'bloomberg_currency/models/quote'
+require 'bloomberg_currency/quote'
+require 'bloomberg_currency/quote_detail'
 
 # Main Gem Module
-module BloombergCurrency
+module BC
 end

data/lib/bloomberg_currency/api/host.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
-module BloombergCurrency
+
+module BC
   module API
     class Host
       URL = 'https://www.bloomberg.com/quote/'.freeze

data/lib/bloomberg_currency/api/site.rb

@@ -1,57 +1,62 @@
 # frozen_string_literal: true
+
 require 'open-uri'
 require 'nokogiri'
 require 'bigdecimal'
 
-module BloombergCurrency
+module BC
   module API
     # Implements site scrapping
     class Site
-      def quote(currency_one, currency_two)
-        BloombergCurrency::Models::Quote.new(process(currency_one, currency_two))
-      end
-
-      private
+      class << self
+        def quote(currency_one, currency_two)
+          process(currency_one, currency_two)
+        end
 
-      def process(currency_one, currency_two)
-        site = load_site(currency_one, currency_two)
-        parse(site)
-      end
+        private
 
-      def load_site(currency_one, currency_two)
-        file = open("#{BloombergCurrency::API::Host::URL}#{currency_one}#{currency_two}:CUR")
-        Nokogiri::HTML(file)
-      end
+        def process(currency_one, currency_two)
+          site = load_site(currency_one, currency_two)
+          parse(site)
+        end
 
-      def parse(document)
-        parse_quote(document)
-      end
+        def load_site(currency_one, currency_two)
+          file = open("#{BC::API::Host::URL}#{currency_one}#{currency_two}:CUR")
+          Nokogiri::HTML(file)
+        end
 
-      def parse_quote(document)
-        price_container          = document.xpath("//div[contains(@class, 'price-container')]")
-        detailed_quote_container = document.xpath("//div[contains(@class, 'detailed-quote')]")
+        def parse(document)
+          parse_quote(document)
+        rescue
+          { price: nil, datetime: nil, detail: nil, available: false }
+        end
 
-        price_element            = price_container.xpath("//div[@class='price']")
-        price_datetime_element   = price_container.xpath("//div[@class='price-datetime']")
+        def parse_quote(document)
+          price_container          = document.xpath("//div[contains(@class, 'price-container')]")
+          detailed_quote_container = document.xpath("//div[contains(@class, 'detailed-quote')]")
 
-        price                    = BigDecimal.new(price_element.text.strip.tr(',', ''))
-        price_datetime           = DateTime.strptime(price_datetime_element.text.strip, 'As of %H:%M %p %z %m/%d/%Y')
-        quote_details_hash       = quote_details(detailed_quote_container)
+          price_element            = price_container.xpath("//div[@class='price']")
+          price_datetime_element   = price_container.xpath("//div[@class='price-datetime']")
 
-        { price: price, price_datetime: price_datetime, quote_details: quote_details_hash }
-      end
+          price                    = price_element.text.strip.tr(',', '').to_f
+          datetime                 = DateTime.strptime(price_datetime_element.text.strip, 'As of %H:%M %p %z %m/%d/%Y')
+          details_hash             = quote_details(detailed_quote_container)
 
-      def quote_details(container)
-        detail_elements = container.xpath("//div[@class='data-table data-table_detailed']").xpath(
-          "//div[contains(@class, 'cell') and contains(@class, 'cell__mobile-basic')]"
-        )
+          { price: price, datetime: datetime, detail: BC::QuoteDetail.new(details_hash), available: true }
+        end
 
-        details_hash = {}
-        details_matrix = detail_elements.map { |a| a.text.strip.split('   ') }
-        details_matrix.each do |key_value_array|
-          details_hash[key_value_array[0].downcase.tr(' ', '_').to_sym] = key_value_array[1]
+        def quote_details(container)
+          detail_elements = container.xpath("//div[@class='data-table data-table_detailed']").xpath(
+            "//div[contains(@class, 'cell') and contains(@class, 'cell__mobile-basic')]"
+          )
+
+          details_hash = {}
+          details_matrix = detail_elements.map { |a| a.text.strip.split('   ') }
+          details_matrix.each do |key_value_array|
+            details_hash[key_value_array[0].downcase.tr(' ', '_').to_sym] = key_value_array[1]
+          end
+          details_hash
         end
-        details_hash
       end
     end
   end

data/lib/bloomberg_currency/quote.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module BC
+  # Quote Information Class
+  class Quote
+    attr_accessor :price, :datetime, :detail, :available
+    def initialize(currency_one, currency_two)
+      result     = BC::API::Site.quote(currency_one, currency_two)
+
+      @price     = result[:price]
+      @datetime  = result[:datetime]
+      @detail    = result[:detail]
+      @available = result[:available]
+    end
+
+    def available?
+      available
+    end
+  end
+end

data/lib/bloomberg_currency/quote_detail.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module BC
+  # Quote Details Class
+  class QuoteDetail
+    attr_accessor :open, :day_range, :previous_close, :last_52_weeks_range, :ytd_return
+
+    def initialize(attributes = {})
+      @open                = process_float(attributes[:open])
+      @day_range           = process_range(attributes[:day_range])
+      @previous_close      = process_float(attributes[:previous_close])
+      @last_52_weeks_range = process_range(attributes[:"52wk_range"])
+      @ytd_return          = process_float(attributes[:ytd_return])
+    end
+
+    private
+
+    def process_range(range)
+      return unless range
+      edges = range.tr(',', '').strip.split('-')
+      edges[0].to_f..edges[1].to_f
+    end
+
+    def process_float(float)
+      return unless float
+      float.tr(',', '').to_f
+    end
+  end
+end

data/lib/bloomberg_currency/version.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
-module BloombergCurrency
-  VERSION = '0.1.0'.freeze
+
+module BC
+  VERSION = '1.0.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bloomberg_currency
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Sebastian Jimenez Velez
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-11 00:00:00.000000000 Z
+date: 2018-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -67,53 +67,73 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.11'
 - !ruby/object:Gem::Dependency
-  name: nokogiri
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: 0.49.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.49.0
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.6.8
+        version: 1.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.6.8
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.45.0
+        version: 3.5.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.45.0
+        version: 3.5.1
 - !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
+  name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
-  type: :development
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.8
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.8
 description: Provides an easy to use API to get currency rates data from the Bloomberg
   website
 email:
@@ -122,6 +142,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".byebug_history"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -139,7 +160,8 @@ files:
 - lib/bloomberg_currency.rb
 - lib/bloomberg_currency/api/host.rb
 - lib/bloomberg_currency/api/site.rb
-- lib/bloomberg_currency/models/quote.rb
+- lib/bloomberg_currency/quote.rb
+- lib/bloomberg_currency/quote_detail.rb
 - lib/bloomberg_currency/version.rb
 homepage: https://github.com/sebasjimenez10/bloomberg_currency
 licenses:
@@ -162,7 +184,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Bloomberg Currency helps you pull currency rates data from the Bloomberg

data/lib/bloomberg_currency/models/quote.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-module BloombergCurrency
-  module Models
-    # Quote Information
-    class Quote
-      attr_accessor :price, :price_datetime, :quote_details
-      def initialize(hash)
-        @price          = hash[:price]
-        @price_datetime = hash[:price_datetime]
-        @quote_details  = hash[:quote_details]
-      end
-    end
-  end
-end