exchanges-rates-nbp 0.0.3 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eecec237aeccf2da7bf37cbcadbc279a1eabad99
-  data.tar.gz: 623b287b7295f2a731da6ccb6bda24f620339e2a
+  metadata.gz: 9c5f535ac6ac56bd9b53da04e2e76c80abb7ea55
+  data.tar.gz: 07e58f2b034a76a7fbc21230b860b45cd5b0f0d4
 SHA512:
-  metadata.gz: bc86f5ba990b21e6877f93798a5c7fc7095671c5abb1cc54db56f7d72997b08292c0193e714a68057b4cb7252516aaee3e50ba94e32b480873c1927a8ee2689f
-  data.tar.gz: c408cbef13ebc8fc108b42903edb5ee4766eebaae27108bebc16081c3cca8b77fefe309241cc9cd4b7adf242561131d0bb2d8cb97764ce1080153ded7d6285c3
+  metadata.gz: 2c54a074354d610b3caf1c329a91cd49c3e02245fdc7c177e7ff31ec97e59e326d30b9a4f240059e57a04595410d027e1b91f041dd91d762f7829ff420cae7cf
+  data.tar.gz: f77539f87e757c55b03aadffd0d63092cda74f1ae0d67bfb7d2844fadde811894da1d487b775571ba9956c3649f45a8d4e10f4d3b020dd9f9126f4e965863c06

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+0.0.1 initial commit
+0.0.2 small bugs
+0.0.3 bug, currency rate  should be float
+1.0.0	selected currencies, creating class to retrieve currency rates
+1.0.2 best practices according to http://guides.rubygems.org/
+1.0.3 CHANGELOG, README

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    exchanges-rates-nbp (0.0.3)
+    exchanges-rates-nbp (1.0.3)
+      nokogiri (~> 1.6)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,6 +1,6 @@
 # Exchanges::Rates::Nbp
 
-Simbple gem that gets exchange rates from the Polish National Bank.
+Simple gem that gets exchange rates from the Polish National Bank.
 
 ## Installation
 
@@ -18,7 +18,42 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Default usage:
+
+		nbp = Exchange::Nbp.new(nil, nil)
+
+,parameters:
+
+* date - default Date.today, you can pass another valid date
+
+* args - optional parameters 
+
+
+Class instance has three important methods:
+
+* codes - returns currency symbols from table,
+
+* published_at - returns publication date exchange rates,
+
+* rates(currency) - returns currency rate at indicated date
+
+
+If you interested only selected currencies at indicated day use in this way:
+
+		nbp = Exchange::Nbp.new(Date.today - 3, {selected_currencies: ['USD', 'EUR']})
+
+
+Now you can retrieve currency rates for chosen:
+
+    nbp.codes.each do |c|
+      nbp.rates(c)
+    end
+
+
+## Future ideas
+1. Currency and CurrencyRate model, Sequel/ActiveRecord migration
+2. Background job to retrieve currency rates automatically
+
 
 ## Contributing
 

data/Rakefile

@@ -1,2 +1,12 @@
 require "bundler/gem_tasks"
 
+desc "Open an irb session preloaded with this library"
+task :console do
+  require 'pry'
+  require 'exchanges-rates-nbp'
+
+  ARGV.clear
+  Pry.start
+
+  #sh "irb -rubygems -I lib -r exchanges-rates-nbp.rb"
+end

data/exchanges-rates-nbp.gemspec

@@ -11,11 +11,12 @@ Gem::Specification.new do |spec|
   spec.email         = ["krzysztof.wieslawski@gmail.com"]
   spec.summary       = %q{Gem to retrieve exchange rates from the Polish National Bank (NBP)}
   spec.description   = %q{}
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/xborn/exchanges-rates-nbp"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
-end
+  spec.add_runtime_dependency "nokogiri", ["~> 1.6"]
+end

data/lib/exchanges/nbp.rb

@@ -0,0 +1,10 @@
+require 'exchanges/rates'
+
+class Exchanges::Nbp
+  include Exchanges::Rates
+
+  def initialize(date, args)
+    @date = date ||= Date.today
+    @selected_currencies = args.nil? ? [] : args[:selected_currencies]
+  end  
+end

data/lib/exchanges/rates.rb

@@ -6,23 +6,17 @@ require 'nokogiri'
 
 module Exchanges
   module Rates
-    NBP = 'http://www.nbp.pl/kursy/xml/'
-
-    @@date = Date.today
 
-    def self.date
-      @@date
-    end
+    attr_accessor :date, :selected_currencies
 
-    def self.date=(at_date)
-      @@date = at_date
-    end
+    NBP = 'http://www.nbp.pl/kursy/xml/'
 
-    def self.codes
-      self.xml.xpath("//pozycja/kod_waluty/text()").map {|c| c.to_s }
+    def codes
+      res = xml.xpath("//pozycja/kod_waluty/text()").map {|c| c.to_s }
+      @selected_currencies.empty? ? res : res.select {|c| @selected_currencies.include?(c)}
     end
 
-    def self.rates(currency)
+    def rates(currency)
       rate = {}
       rate[:symbol] = xml.xpath("//pozycja[kod_waluty='#{currency}']/kod_waluty/text()").to_s
       rate[:name] = xml.xpath("//pozycja[kod_waluty='#{currency}']/nazwa_waluty/text()").to_s
@@ -31,28 +25,27 @@ module Exchanges
       rate
     end
 
-    def self.published_at
+    def published_at
       Date.parse(xml.xpath("//tabela_kursow/data_publikacji/text()").to_s)
     end
 
-    private
-    def self.filename
+    def filename
       # according to: http://www.nbp.pl/home.aspx?f=/kursy/instrukcja_pobierania_kursow_walut.html
       index = Net::HTTP.get(URI.parse(NBP + 'dir.txt'))
 
-      while index[/(a[0-9][0-9][0-9]z#{@@date.strftime("%y%m%d")}+)/, 1].nil? do
-        @@date -= 1
+      while index[/(a[0-9][0-9][0-9]z#{@date.strftime("%y%m%d")}+)/, 1].nil? do
+        @date -= 1
       end
-      index[/(a[0-9][0-9][0-9]z#{@@date.strftime("%y%m%d")}+)/, 1]
-    end
+      index[/(a[0-9][0-9][0-9]z#{@date.strftime("%y%m%d")}+)/, 1]
+    end     
 
-    def self.url 
-      File.join(NBP, self.filename + '.xml') if self.filename
+    def url
+      File.join(NBP, filename + '.xml') if filename
     end
 
-    def self.xml
+    def xml
       begin
-        doc = open(self.url)
+        doc = open(url)
       rescue Exception => e
         puts e.message
         puts e.backtrace.inspect
@@ -60,5 +53,6 @@ module Exchanges
 
       Nokogiri::HTML(doc) if doc
     end
+   
   end
 end

data/lib/exchanges/version.rb

@@ -1,3 +1,3 @@
 module Exchanges
-  VERSION = "0.0.3"
+  VERSION = "1.0.3"
 end

data/lib/exchanges-rates-nbp.rb

@@ -0,0 +1 @@
+require 'exchanges/nbp'

data/spec/exchanges_nbp_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+RSpec.describe Exchanges::Nbp do
+
+  before(:all) do
+    @dummy = Exchanges::Nbp.new(nil, nil)
+  end
+
+  context 'when date is not passed' do
+    it 'returns @date equal Date.today' do
+      expect(@dummy.date).to eq Date.today
+    end
+  end
+
+  context 'when date is passed e.g. \'2014-08-31\'' do
+    before(:all) do
+      @dummy = Exchanges::Nbp.new(Date.new(2014,8,31), nil)
+    end
+
+    it 'returns @date equal Date.today' do
+      expect(@dummy.date).to eq Date.new(2014,8,31)
+    end
+  end
+
+  context 'when two valid currencies are chosen' do
+    before(:all) do
+      @dummy = Exchanges::Nbp.new(nil, {selected_currencies: ['USD','EUR']})
+    end
+
+    it '#codes returns 2-elements Array' do
+      expect(@dummy.codes).to be_kind_of(Array)
+      expect(@dummy.codes.length).to eq 2
+    end
+  end
+
+  context 'when any currencies are selected at \'2014-08-31\'' do
+    before(:all) do
+      @dummy = Exchanges::Nbp.new(nil, nil)
+    end
+
+    it '#codes returns 36-elements Array' do
+      expect(@dummy.codes.length).to eq 36
+    end
+  end  
+
+end

data/spec/exchanges_rates_spec.rb

@@ -0,0 +1,141 @@
+require 'spec_helper'
+
+class DummyClass
+  include Exchanges::Rates
+
+  def initialize(date, args)
+    @date = date ||= Date.today
+    @selected_currencies = args.nil? ? [] : args[:selected_currencies]
+  end
+end
+
+RSpec.describe Exchanges::Rates do
+  include Exchanges::Rates
+
+  context 'when date is default' do
+    before(:each) do
+      @dummy = DummyClass.new(Date.today, nil)
+    end
+
+    describe 'constant NBP' do
+      it 'responds to constant NBP' do
+        expect(Exchanges::Rates::NBP).to be
+      end
+      it 'NBP is url' do
+        expect(Exchanges::Rates::NBP.match(/^http:\/\//)).to be_truthy
+      end
+    end
+
+    describe '@date' do
+      it 'module responds to @@date' do
+        expect(@dummy.date).to be
+      end
+      it 'default @date is today' do
+        expect(@dummy.date).to eq Date.today
+      end
+      it 'is possible to change @date' do
+        @dummy.date = Date.today - 3
+        expect(@dummy.date).to eq Date.today - 3
+      end
+    end
+
+    it 'returns url to xml file' do
+      expect(@dummy.url.match(/.xml$/)).to be_truthy
+    end
+
+    describe '#xml' do
+      it 'returns xml for chosen date' do
+        xml = @dummy.xml
+        expect(xml.xpath("//data_publikacji/text()").to_s).to eq @dummy.date.strftime("%Y-%m-%d")
+      end
+    end
+
+    describe '#codes' do
+      it 'returns array' do
+        expect(@dummy.codes).to be_kind_of(Array)
+      end
+    end
+
+    describe '#rates' do
+      it 'returns Hash contained necessary informations' do
+        expect(@dummy.rates('USD')).to be_kind_of(Hash)
+      end
+      it 'Hash contains keys :symbol, :name, :base, :average_rate' do
+        expect(@dummy.rates('USD').keys.sort).to eq [:average_rate, :base, :name, :symbol]
+      end
+      it 'rate is a Float' do
+        expect(@dummy.rates('USD')[:average_rate]).to be_kind_of(Float)
+      end
+      it 'symbol, name, base and rate are not empty' do
+        [:symbol, :name, :base, :average_rate].each do |k|
+          expect(@dummy.rates('USD')[k].to_s).not_to be_empty
+        end
+      end
+    end
+
+    describe '#published_at' do
+      it 'returns Date' do
+        expect(@dummy.published_at).to be_kind_of(Date)
+      end
+    end
+
+  end
+
+  context 'when date is weekend day \'2014-08-31\', Sunday' do
+    before(:each) do
+      @dummy = DummyClass.new(Date.new(2014, 8, 31), nil)
+    end
+
+    describe '#filename' do
+      it 'returns \'a167z140829\' for Sunday, 2014-08-31\'' do
+        expect(@dummy.filename).to eq 'a167z140829'
+      end
+      it 'returns \'a167z140829\' for Friday, 2014-08-29\'' do
+        expect(@dummy.filename).to eq 'a167z140829'
+      end
+    end
+
+    describe '#rates' do
+      it 'at \'2014-08-31\' USD rate is 3.1965 (from table at \'2014-08-29\')' do
+        expect(@dummy.rates('USD')[:average_rate]).to eq 3.1965
+      end
+    end
+  end
+
+  context 'when only \'USD\' is selected' do
+    before(:each) do
+      @dummy = DummyClass.new(Date.new(2014, 8, 31), {selected_currencies: ['USD']})
+    end
+
+    describe '#codes' do
+      it 'returns only one code' do
+        expect(@dummy.codes.length).to eq 1
+      end  
+    end
+  end
+
+  context 'when only \'USD\', \'EUR\' and \'GBP\' are selected' do
+    before(:each) do
+      @dummy = DummyClass.new(Date.new(2014, 8, 31), {selected_currencies: ['USD', 'EUR', 'GBP']})
+    end
+
+    describe '#codes' do
+      it 'returns three codes' do
+        expect(@dummy.codes.length).to eq 3
+      end  
+    end
+  end 
+
+  context 'when wrong code is selected' do
+    before(:each) do
+      @dummy = DummyClass.new(Date.new(2014, 8, 31), {selected_currencies: ['XXX']})
+    end
+
+    describe '#codes' do
+      it 'returns three codes' do
+        expect(@dummy.codes.length).to eq 0
+      end  
+    end
+  end  
+
+end

data/spec/spec_helper.rb

@@ -1,7 +1,7 @@
 require 'rubygems'
 require 'bundler/setup'
 
-require 'nbp'
+require 'exchanges/nbp'
 
 RSpec.configure do |config|
 

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: exchanges-rates-nbp
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 1.0.3
 platform: ruby
 authors:
 - krzysztof.wieslawski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-05 00:00:00.000000000 Z
-dependencies: []
+date: 2014-10-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
 description: ''
 email:
 - krzysztof.wieslawski@gmail.com
@@ -18,6 +32,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - Guardfile
@@ -25,13 +40,15 @@ files:
 - README.md
 - Rakefile
 - exchanges-rates-nbp.gemspec
+- lib/exchanges-rates-nbp.rb
+- lib/exchanges/nbp.rb
 - lib/exchanges/rates.rb
 - lib/exchanges/version.rb
-- lib/nbp.rb
-- spec/exchanges-rates-nbp_spec.rb
+- spec/exchanges_nbp_spec.rb
+- spec/exchanges_rates_spec.rb
 - spec/spec_helper.rb
 - spec/support/a167z140829.xml
-homepage: ''
+homepage: https://github.com/xborn/exchanges-rates-nbp
 licenses:
 - MIT
 metadata: {}
@@ -56,6 +73,7 @@ signing_key:
 specification_version: 4
 summary: Gem to retrieve exchange rates from the Polish National Bank (NBP)
 test_files:
-- spec/exchanges-rates-nbp_spec.rb
+- spec/exchanges_nbp_spec.rb
+- spec/exchanges_rates_spec.rb
 - spec/spec_helper.rb
 - spec/support/a167z140829.xml

data/lib/nbp.rb

@@ -1,2 +0,0 @@
-require 'exchanges/version'
-require 'exchanges/rates'

data/spec/exchanges-rates-nbp_spec.rb

@@ -1,95 +0,0 @@
-require 'spec_helper'
-
-RSpec.describe Exchanges::Rates do
-
-  context 'when date is default' do
-    before(:each) do
-      Exchanges::Rates.date = Date.today
-    end
-
-    describe 'constant NBP' do
-      it 'responds to constant NBP' do
-        expect(Exchanges::Rates::NBP).to be
-      end
-      it 'NBP is url' do
-        expect(Exchanges::Rates::NBP.match(/^http:\/\//)).to be_truthy
-      end
-    end
-
-    describe '@@date' do
-      it 'module responds to @@date' do
-        expect(Exchanges::Rates.date).to be
-      end
-      it 'default @@date is today' do
-        expect(Exchanges::Rates.date).to eq Date.today
-      end
-      it 'is possible to change @@date' do
-        Exchanges::Rates.date = Date.today - 3
-        expect(Exchanges::Rates.date).to eq Date.today - 3
-      end
-    end
-
-    it 'returns url to xml file' do
-      expect(Exchanges::Rates.url.match(/.xml$/)).to be_truthy
-    end
-
-    describe '.xml' do
-      it 'returns xml for chosen date' do
-        xml = Exchanges::Rates.xml
-        expect(xml.xpath("//data_publikacji/text()").to_s).to eq Exchanges::Rates.date.strftime("%Y-%m-%d")
-      end
-    end
-
-    describe '.codes' do
-      it 'returns array' do
-        expect(Exchanges::Rates.codes).to be_kind_of(Array)
-      end
-    end
-
-    describe '.rates' do
-      it 'returns Hash contained necessary informations' do
-        expect(Exchanges::Rates.rates('USD')).to be_kind_of(Hash)
-      end
-      it 'Hash contains keys :symbol, :name, :base, :average_rate' do
-        expect(Exchanges::Rates.rates('USD').keys.sort).to eq [:average_rate, :base, :name, :symbol]
-      end
-      it 'rate is a Float' do
-        expect(Exchanges::Rates.rates('USD')[:average_rate]).to be_kind_of(Float)
-      end
-      it 'symbol, name, base and rate are not empty' do
-        [:symbol, :name, :base, :average_rate].each do |k|
-          expect(Exchanges::Rates.rates('USD')[k].to_s).not_to be_empty
-        end
-      end
-    end
-
-    describe '.published_at' do
-      it 'returns Date' do
-        expect(Exchanges::Rates.published_at).to be_kind_of(Date)
-      end
-    end
-
-  end
-
-  context 'when date is weekend day \'2014-08-31\', Sunday' do
-    before(:each) do
-      Exchanges::Rates.date = Date.new(2014,8,31)
-    end
-
-    describe '.filename' do
-      it 'returns filename \'a167z140829\' for Sunday, 2014-08-31\'' do
-        expect(Exchanges::Rates.filename).to eq 'a167z140829'
-      end
-      it 'returns filename \'a167z140829\' for Friday, 2014-08-29\'' do
-        expect(Exchanges::Rates.filename).to eq 'a167z140829'
-      end
-    end
-
-    describe '.rates' do
-      it 'at \'2014-08-31\' USD rate is 3.1965 (from table at \'2014-08-29\')' do
-        expect(Exchanges::Rates.rates('USD')[:average_rate]).to eq 3.1965
-      end
-    end
-  end
-
-end