momm 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8bfaf35e8c7c6d5a3df2b10c78e0d840de8903b9
+  data.tar.gz: 46e99175387cb4ab1823d858a0b4e60afbdfdefb
+SHA512:
+  metadata.gz: 31d92303e463cd6b831855472f9e8595a75972ef6c579e6288e1487cf1f7ec6973188c20be089419ce8ad71296c5aaf067dcba9a3a1d1d39c3dd699b9b931fba
+  data.tar.gz: e02cb0d88441d39df19ea6a86780d30b24bd1ebf5f932b52df83214ec0ab10f53313ccb34d77c61e056571459a6e9968958d48169dd90e0542fc023c26ee88d6

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in momm.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jingkai He
+
+MIT License
+
+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.

data/README.md

@@ -0,0 +1,118 @@
+# Momm
+
+Money on My Mind - An awesome gem for currency exchange.
+
+```
+                   __  __                                        __  __
+                  |  \/  |                                      |  \/  |
+                  | \  / | ___  _ __   ___ _   _    ___  _ __   | \  / |_   _
+                  | |\/| |/ _ \| '_ \ / _ \ | | |  / _ \| '_ \  | |\/| | | | |
+                  | |  | | (_) | | | |  __/ |_| | | (_) | | | | | |  | | |_| |
+                  |_|  |_|\___/|_| |_|\___|\__, |  \___/|_| |_| |_|  |_|\__, |
+                                            __/ |                        __/ |
+                                           |___/                        |___/
+                                       __  __ _           _
+                                      |  \/  (_)         | |
+                                      | \  / |_ _ __   __| |
+                                      | |\/| | | '_ \ / _` |
+                                      | |  | | | | | | (_| |
+                                      |_|  |_|_|_| |_|\__,_|
+
+
+                            Keep calm bro. We'll calculate rate for you.
+
+```
+
+## Requirement
+
+Ensure that [Memcached](http://memcached.org/) or [Redis](http://redis.io/) is installed on your local machine or server or provided by some other cloud service providers. Those are for exchange rate storage, which ensure your fast queries.
+
+Local storage is not provided, because it might not safe for work on Cloud Platforms such as Heroku.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'momm'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install momm
+
+## Usage
+
+### Off Rails
+
+#### Command Line Tool
+
+The storage engine by default is Redis, ensure the socket is opened.
+
+```
+  $ momm rate GBP CNY                  # Exchange rate by default is today.
+  $ momm exchange 100 GBP USD 2014-3-1 # Exchange rate at 2013-3-1
+```
+
+If you want to change the storage strategies, edit it in your ~/.mom/config.yml file.
+
+#### Ruby
+
+``` ruby
+  require 'momm'
+
+  Momm.exchange_rate 'GBP', 'USD' # By default Today
+  Momm.exchange_rate 'GBP', 'USD', date: Date.today
+  Momm.exchange_rate_from_gbp_to_usd, date: "2014-3-4"
+
+  Momm.exchange 100, 'GBP', 'USD'
+  Momm.exchange 100, 'GBP', 'USD', date: Date.today
+  Momm.exchange_from_gbp_to_usd 100
+  Momm.exchange_from_gbp_to_usd 100, date: "2014-3-4"
+
+```
+
+#### Configuration
+
+``` ruby
+
+  Momm.store :redis_store # Use redis as the default storage
+
+  Momm.fed :ECB # Use ECB as the default currency exchange feeds
+
+```
+
+### Momm on Rails
+
+Web service is provided by Momm on Rails, however you need to install sinatra simply by adding ```gem 'sinatra'``` into your Gemfile. Then require ```momm/web``` module and edit your routes like:
+
+``` ruby
+  # routes.rb
+
+  require 'momm/web'
+
+  Myapp::Application.routes.draw do
+    mount Momm::Web => '/momm'
+  end
+```
+
+The default Storage is Memcached, if you want to switch to Redis, you can create an intialzier like:
+
+``` ruby
+
+  # momm_initialzer.rb
+  Momm.store :redis_store, host: "127.0.0.1"
+  Momm.source :ECB
+```
+
+### @TODO: A small widget
+
+## Contributing
+
+1. Fork it ( https://github.com/jaxi/momm/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,16 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+desc "Run an IRB session with Momm preloaded"
+task :console do
+  exec "irb -I lib -r momm"
+end
+
+desc "Run the test suite"
+RSpec::Core::RakeTask.new(:rspec) do |t|
+  t.pattern = FileList['spec/**/*_spec.rb']
+  t.rspec_opts = %w|--color|
+end
+
+task default: :spec
+

data/bin/momm

@@ -0,0 +1,72 @@
+#!/usr/bin/env ruby
+$LOAD_PATH << File.dirname(__FILE__) + "/../lib" if $0 == __FILE__
+
+require 'optparse'
+require 'momm'
+
+OPERATIONS = %w{rate exchange}
+
+option_parser = OptionParser.new do |opts|
+  opts.banner = Momm::BANNER
+
+  opts.separator <<-EOS
+
+Supported commands:
+
+ rate [country_code] [country_code] [YYYY-MM-DD]                   Display rate!
+ exchange [money] [country_code] [country_code] [YYYY-MM-DD]       Exchange for you!
+
+Examples:
+ mmom exchange 20 GBP CNY      Convert the between currencies
+ mmom rate GBP CNY             Simply display the rate
+
+Support Code:
+
+#{Momm.currencies.join(" ")}
+
+To be honest I don't know most of them...
+
+EOS
+end
+
+option_parser.parse!
+
+
+op = ARGV.shift
+if OPERATIONS.include?(op)
+  begin
+    case op
+    when "rate"
+      from = ARGV[0].to_sym
+      to = ARGV[1].to_sym
+      date = if ARGV[2]
+        Date.parse(ARGV[2])
+      else
+        Date.today
+      end
+
+      puts Momm.exchange_rate from, to, date: date
+    when "exchange"
+      money = ARGV[0].to_f
+      from = ARGV[1].to_sym
+      to = ARGV[2].to_sym
+      date = if ARGV[3]
+        Date.parse(ARGV[3])
+      else
+        Date.today
+      end
+
+      puts Momm.exchange money, from, to, date: date
+    end
+
+  rescue ArgumentError => ex
+    puts ex.message
+
+  rescue Exception => e
+    puts "Mmmmm, I didn't expect this:"
+    puts e.message
+    puts e.backtrace.join("\n")
+  end
+else
+  puts option_parser.help
+end

data/lib/momm/calculator.rb

@@ -0,0 +1,129 @@
+module Momm
+  class Calculator
+    extend ::Forwardable
+    # Initialise Storage Object
+    #
+    # == Parameters:
+    # client::
+    #   A storage, such as memcached, redis
+    # == Returns
+    # self
+    #
+    def initialize(storage = Memcached.new, feed = Feeds::ECB.instance)
+      @storage = storage
+      @feed = feed
+    end
+
+    attr_reader :storage, :feed
+
+    # delegate the client and update method from storage
+    delegate [:client, :update, :set_rate] => :storage
+
+    # delegate the currencies method from feed
+    delegate :currencies => :feed
+
+    # delegate the get rate method with a different naming
+    def_delegator :storage, :get_rate, :get_rate_origin
+
+    # Exchange Rate
+    #
+    # == Parameters
+    # from::
+    #   ruby symbol, such as :USD, :GBP
+    # to::
+    #   same as above
+    # options::
+    #   0ption parameters, contain today by default
+    #
+    # == Returns
+    # the exchange rate
+    #
+    def exchange_rate(from, to, options = {})
+      date = options[:date] || Date.today
+      date = Date.parse(date) if date.is_a? String
+
+      max_count = 10
+      date_counter = date
+
+      # @TODO Refactoring.
+      # It seems that currency does not have feeds at weekends, so
+      # we simply find the closest day which has currency feeds.
+      while max_count > 0
+        to_rate = get_rate(to, date_counter)
+        from_rate = get_rate(from, date_counter)
+
+        date_counter -=1
+        max_count -= 1
+        next if to_rate == 0 || from_rate == 0
+
+        set_rate(to, to_rate, date)
+        set_rate(from, from_rate, date)
+
+        return (to_rate / from_rate).round(2)
+      end
+
+      0.0 / 0
+    end
+
+    # Exchange Money from one currency to another
+    #
+    # == Parameters
+    # money::
+    #   money you have
+    # from::
+    #   ruby symbol, such as :USD, :GBP
+    # to::
+    #   same as above
+    # options::
+    #   option parameters, contain today by default
+    #
+    # == Returns
+    # money exchanged
+    #
+    def exchange(money, from, to, options= {})
+      options[:date] ||= Date.today
+      (money * exchange_rate(from, to, options)).round(2)
+    end
+
+    # Delegate the get_rate method, if the target is missing
+    # Fetching all data from remote
+    #
+    # == Parameters
+    #
+    # date::
+    #   Default is Date.today
+    # currency::
+    #   Currency passed in
+    # == Returns
+    # the currency rate
+    #
+    def get_rate(from, date = Date.today)
+      res = get_rate_origin(from, date)
+      return res if res != 0 && res
+
+      update(feed.currency_rates)
+      get_rate_origin(from, date)
+    end
+
+    # @TODO: Refactoring
+    def method_missing(meth, *args, &block)
+      meth = meth.to_s
+      case
+      when meth.match(/^exchange_rate_from_(\w+)_to_(\w+)/)
+        exchange_rate($1.upcase.to_sym, $2.upcase.to_sym, *args, &block)
+      when meth.match(/^exchange_from_(\w+)_to_(\w+)/)
+        money, *res = args
+        exchange(money, $1.upcase.to_sym, $2.upcase.to_sym, *res, &block)
+      else
+        super
+      end
+    end
+
+    def respond_to?(meth, include_private = false)
+      meth = meth.to_s
+      meth.match(/^exchange_rate_from_(\w+)_to_(\w+)/) ||
+        meth.match(/^exchange_from_(\w+)_to_(\w+)/) ||
+          super
+    end
+  end
+end

data/lib/momm/feeds/ecb.rb

@@ -0,0 +1,67 @@
+require 'httparty'
+require 'open-uri'
+
+module Momm
+  module Feeds
+    class ECB
+
+      FETCHING_URL = "http://www.ecb.europa.eu/stats/eurofxref/eurofxref-hist-90d.xml".freeze
+
+      #Hard coded for good
+      CURRENCIES = %w{USD JPY BGN CZK DKK GBP HUF LTL PLN RON SEK CHF
+        NOK HRK RUB TRY AUD BRL CAD CNY HKD IDR ILS INR KRW
+        MXN MYR NZD PHP SGD THB ZAR}.freeze
+
+      class << self
+
+        # Eager loading the instance of ECB
+        #
+        # == Returns
+        # self
+        #
+        def instance
+          @instance ||= self.send :new
+        end
+      end
+
+      # should be a singleton class
+      private_class_method :new
+
+      # Parse the XML data by Nokogiri
+      # == Returns
+      # Nokogiri Object
+      #
+      def parsed_content
+        # @TODO Refactoring Bad patterns
+        HTTParty.get(fetching_url, format: :xml)['Envelope']['Cube']['Cube']
+      end
+
+      # convert the nokogiri parsed data to array
+      #
+      # == Returns
+      # looks like [{date: Date.now, currency: :CNY, rate: 1.23} ...]
+      #
+      def currency_rates
+        parsed_content.map do |content|
+          date = Date.parse(content["time"])
+          cubes = content["Cube"]
+          cubes.map do |cube|
+            {
+              date: date,
+              currency: cube["currency"].to_sym,
+              rate: cube["rate"].to_f
+            }
+          end
+        end.flatten
+      end
+
+      def fetching_url
+        FETCHING_URL
+      end
+
+      def currencies
+        CURRENCIES
+      end
+    end
+  end
+end

data/lib/momm/memcached.rb

@@ -0,0 +1,22 @@
+require 'dalli'
+
+module Momm
+  class Memcached < Storage
+
+    DEFAULT_OPTIONS = {
+      connection: "localhost:11211", namespace: "momm", compress: true
+    }.freeze
+
+    attr_reader :connection, :options
+
+    def initialize(options={})
+      _options = DEFAULT_OPTIONS.dup.merge options
+      @connection = options.delete(:connection)
+      @options = options
+    end
+
+    def client
+      @client ||= Dalli::Client.new connection, options
+    end
+  end
+end

data/lib/momm/redis_store.rb

@@ -0,0 +1,24 @@
+require 'redis'
+
+module Momm
+  class RedisStore < Storage
+    DEFAULT_OPTIONS = { host: "localhost", port: 6379, namespace: "momm"}
+
+    attr_accessor :options
+
+    def initialize(options = {})
+      @options = DEFAULT_OPTIONS.dup.merge options
+    end
+
+    def client
+      @client ||= begin
+        ns = options.delete(:namespace)
+
+        require 'redis/namespace'
+        native_client = Redis.new options
+
+        Redis::Namespace.new(ns, :redis => native_client)
+      end
+    end
+  end
+end

data/lib/momm/storage.rb

@@ -0,0 +1,68 @@
+module Momm
+  class Storage
+    # The presenter model to rule the behavior of storage.
+
+    # Lazy load  Client
+    #
+    # == Returns
+    #  Client
+    #
+    def client
+      raise NotImplementedError
+    end
+
+    # Insert the currency rate to client
+    #
+    # == Parameters
+    # currency::
+    #   Currency passed in, should be a symbol of iso code,
+    #   such as :CNY, :USD, or :GBP
+    # rate::
+    #   Fixnum represent for the currency rate
+    #   from euro to certain currency
+    # date::
+    #   Ruby date type, the date of currency rate, today by default
+    #
+    # == Returns
+    # nil
+    #
+    def set_rate(currency, rate, date = Date.today)
+      date = Date.parse(date) if date.is_a? String
+      client.set "#{date}#{currency}", rate
+    end
+
+    # Fetch the currency rate from client
+    #
+    # == Parameters
+    # currency::
+    #   Currency passed in
+    # date::
+    #   Ruby date type, the date of currency rate, today by default
+    #
+    # == Returns
+    # the currency rate
+    #
+    def get_rate(currency, date = Date.today)
+      date = Date.parse(date) if date.is_a? String
+      client.get("#{date}#{currency}").to_f
+    end
+
+    # update the data to storage
+    #
+    # == parameters
+    # data::
+    #   An array looks like [{date: Date.now, currency: :CNY, rate: 1.23} ...]
+    #
+    # == Returns
+    # nil
+    #
+    def update(data)
+      data.each do |d|
+        set_rate d[:currency], d[:rate], d[:date]
+      end
+      nil
+    end
+
+    NotImplementedError = Class.new(StandardError)
+  end
+end

data/lib/momm/version.rb

@@ -0,0 +1,3 @@
+module Momm
+  VERSION = "0.0.1"
+end

data/lib/momm/web.rb

@@ -0,0 +1,28 @@
+require 'sinatra/base'
+require 'momm'
+
+module Momm
+  class Web < ::Sinatra::Base
+    get '/query' do
+      content_type :json
+
+      money = params[:money].to_f
+      from = params[:from].to_sym
+      to = params[:to].to_sym
+      date = params[:date] || Date.today
+
+
+      if money && from && to && date
+        Momm.exchange(money, from, to, date: date).to_json
+      else
+        "N/A"
+      end
+
+    end
+
+    get '/currencies' do
+      content_type :json
+      Momm.currencies.to_json
+    end
+  end
+end