open_exchange_rates 0.2.1 → 0.3.0

data/.gitignore

@@ -1,5 +1,6 @@
 *.gem
 *.rbc
+.env
 .bundle
 .config
 .yardoc

data/README.md

@@ -1,5 +1,7 @@
 # OpenExchangeRates
 
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/vlado/open_exchange_rates)
+
 Ruby gem for currency conversion based on [Open Exchange Rates API](http://openexchangerates.org) - free / open source hourly-updated currency data for everybody
 
 ## Accuracy
@@ -19,6 +21,31 @@ And then execute:
 Or install it yourself as:
 
     $ gem install open_exchange_rates
+    
+## Configuration
+
+You will need App ID to use OpenExchangeRates, you can get one for free [here](https://openexchangerates.org/signup/). Wanna know [why App ID is needed](http://www.josscrowcroft.com/2012/projects/open-exchange-rates-update-the-partys-not-over-it-just-got-a-little-too-noisy/).
+
+**Option 1**
+
+Set OPEN_EXCHANGE_RATES_APP_ID environment variable and it will be used automatically. If you are using [foreman](http://ddollar.github.com/foreman/) for example just add it to your .env file like this
+
+	OPEN_EXCHANGE_RATES_APP_ID=YourAppID
+
+**Option 2**
+
+	OpenExchangeRates.configure do |config|
+  	  config.app_id = "YourAppID"
+	end
+	
+If you are using Rails good place to add this is config/initializers/open_exchange_rates.rb
+	
+**Option 3**
+
+Pass it on initialization
+	
+	fx = OpenExchangeRates::Rates.new(:app_id => "YourAppID")
+	
 
 ## Usage
 

data/env.example

@@ -0,0 +1 @@
+OPEN_EXCHANGE_RATES_APP_ID=YourAppID

data/lib/open_exchange_rates/configuration.rb

@@ -0,0 +1,5 @@
+module OpenExchangeRates
+  class Configuration
+    attr_accessor :app_id
+  end
+end

data/lib/open_exchange_rates/rates.rb

@@ -3,6 +3,17 @@ require "open-uri"
 module OpenExchangeRates
   class Rates
 
+    class MissingAppIdError < StandardError
+      def initialize(msg = "Go to https://openexchangerates.org/signup to get App ID and then add it to the configuration: OpenExchangeRates.configuration.app_id = 'your app id'")
+        super(msg)
+      end
+    end
+
+    def initialize(app_id = nil)
+      @app_id = app_id || OpenExchangeRates.configuration.app_id
+      raise MissingAppIdError unless @app_id
+    end
+
     def exchange_rate(options = {})
       from_curr = options[:from].to_s.upcase
       to_curr = options[:to].to_s.upcase
@@ -44,12 +55,12 @@ module OpenExchangeRates
 
     def parse_latest
       @latest_parser ||= OpenExchangeRates::Parser.new
-      @latest_parser.parse(open(OpenExchangeRates::LATEST_URL))
+      @latest_parser.parse(open("#{OpenExchangeRates::LATEST_URL}?app_id=#{@app_id}"))
     end
 
     def parse_on(date_string)
       @on_parser = OpenExchangeRates::Parser.new
-      @on_parser.parse(open("#{OpenExchangeRates::BASE_URL}/historical/#{date_string}.json"))
+      @on_parser.parse(open("#{OpenExchangeRates::BASE_URL}/historical/#{date_string}.json?app_id=#{@app_id}"))
     end
 
   end

data/lib/open_exchange_rates/version.rb

@@ -1,3 +1,3 @@
 module OpenExchangeRates
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

data/lib/open_exchange_rates.rb

@@ -1,5 +1,6 @@
 require "rubygems"
 require "open_exchange_rates/version"
+require "open_exchange_rates/configuration"
 require "open_exchange_rates/parser"
 require "open_exchange_rates/response"
 require "open_exchange_rates/rates"
@@ -7,4 +8,18 @@ require "open_exchange_rates/rates"
 module OpenExchangeRates
   BASE_URL = "http://openexchangerates.org"
   LATEST_URL = "#{BASE_URL}/latest.json"
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= OpenExchangeRates::Configuration.new
+    yield(configuration)
+  end
+end
+
+# Default configuration
+OpenExchangeRates.configure do |config|
+  config.app_id = ENV['OPEN_EXCHANGE_RATES_APP_ID']
 end

data/test/rates_test.rb

@@ -2,6 +2,26 @@ require "test_helper"
 
 class TestOpenExchangeRates < Test::Unit::TestCase
 
+  def test_app_id_is_required
+    assert_nothing_raised { OpenExchangeRates::Rates.new }
+
+    stub(OpenExchangeRates.configuration).app_id { nil }
+    assert_raise(OpenExchangeRates::Rates::MissingAppIdError) { OpenExchangeRates::Rates.new }
+
+    assert_nothing_raised { OpenExchangeRates::Rates.new(:app_id => "myappid") }
+
+    OpenExchangeRates.configuration.app_id = ENV['OPEN_EXCHANGE_RATES_APP_ID']
+  end
+
+  def test_invalid_app_id_raise_error
+    stub(OpenExchangeRates.configuration).app_id { "somethingstupid" }
+    fx = OpenExchangeRates::Rates.new
+
+    assert_raise NoMethodError do
+      fx.exchange_rate(:from => "USD", :to => "EUR")
+    end
+  end
+
   def test_exchange_rate
     fx = OpenExchangeRates::Rates.new
     stub(fx).parse_latest { OpenExchangeRates::Parser.new.parse(open_asset("latest.json")) }
@@ -123,11 +143,10 @@ class TestOpenExchangeRates < Test::Unit::TestCase
 
     assert_equal "USD", on_rates.base_currency
     assert_equal "USD", on_rates.base
-    assert on_rates.rates.is_a?(Hash)
 
     assert_equal 1, on_rates.rates["USD"]
-    assert_equal 0.99458, on_rates.rates["AUD"]
-    assert_equal 5.80025, on_rates.rates["HRK"]
+    assert_equal 0.991118, on_rates.rates["AUD"]
+    assert_equal 5.795542, on_rates.rates["HRK"]
   end
 
   def test_round
@@ -141,6 +160,7 @@ class TestOpenExchangeRates < Test::Unit::TestCase
 
   def test_multiple_calls
     fx = OpenExchangeRates::Rates.new
+
     assert_nothing_raised do
       fx.convert(123, :from => "EUR", :to => "AUD", :on => "2012-03-10")
       fx.convert(100, :from => "USD", :to => "EUR")

data/test/test_helper.rb

@@ -3,6 +3,17 @@ require "test/unit"
 require "rr"
 require "open_exchange_rates"
 
+# Pick up ENV variables from .env file if exists
+dot_env_file_path = File.expand_path("../../.env", __FILE__)
+if File.exist?(dot_env_file_path)
+  File.open(dot_env_file_path).each_line do |line|
+    key, value = line.strip.split("=")
+    ENV[key] = value unless key.nil? || value.nil?
+  end
+end
+
+OpenExchangeRates.configuration.app_id = ENV['OPEN_EXCHANGE_RATES_APP_ID']
+
 class Test::Unit::TestCase
   include RR::Adapters::TestUnit
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: open_exchange_rates
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: 
   segments: 
   - 0
-  - 2
-  - 1
-  version: 0.2.1
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Vlado Cingel
@@ -15,12 +15,10 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-06-13 00:00:00 Z
+date: 2012-07-14 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: yajl-ruby
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -29,12 +27,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
+  requirement: *id001
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rr
+  name: yajl-ruby
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -43,12 +41,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
+  requirement: *id002
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rake
+  name: rr
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -57,8 +55,10 @@ dependencies:
         segments: 
         - 0
         version: "0"
+  requirement: *id003
   type: :development
-  version_requirements: *id003
+  name: rake
+  prerelease: false
 description: Ruby library for Open Exchange Rates API - free / open source hourly-updated currency data for everybody
 email: 
 - vladocingel@gmail.com
@@ -74,7 +74,9 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- env.example
 - lib/open_exchange_rates.rb
+- lib/open_exchange_rates/configuration.rb
 - lib/open_exchange_rates/parser.rb
 - lib/open_exchange_rates/rates.rb
 - lib/open_exchange_rates/response.rb
@@ -122,4 +124,3 @@ test_files:
 - test/assets/latest.json
 - test/rates_test.rb
 - test/test_helper.rb
-has_rdoc: