btc_price 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9c22316b62b88011503e3ed00673873eb2d104a7
+  data.tar.gz: c23e0f1f7293b9761ae63038b1184ea01c7f5942
+SHA512:
+  metadata.gz: 695989ee06c588b96daf4c43f27569759949766498a927c470c4ac4db78de9e5eb3141a07c7374dbd3c4b5d7d82d26c8205623619352f44ed4c9677896ba2970
+  data.tar.gz: d8f1ba3be11f91716694ba7ff9a6d171505d7af2bca8a83c0e2f157b503ec8e4a0ff819fdaa002841992d79c776866d6edf323878bc9af7afcd1a61bbf3a29c2

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/.travis.yml

@@ -0,0 +1,9 @@
+deploy:
+  provider: rubygems
+  api_key:
+    secure: "DsYnX0Ju3juHWMJLUfWh3fUEfXpTq8Ifpsm0xP4GAxpZbt6OHt2thtUdnOlCuvE7PwTLu1noj2BmKXMdrZf2p3CLOcvG2HH3Dhlizrxm6bmRK7EBw+OjP5udSg++TDddeBjJcB7RbNX898gOhr9OdzktibtBmwDsbHyCH3F8dm4="
+language: ruby
+rvm:
+  - 2.1.1
+services:
+  - memcached

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Matt Campbell
+
+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,44 @@
+[![Build Status](https://travis-ci.org/mecampbellsoup/btc_price.png?branch=master)](https://travis-ci.org/mecampbellsoup/btc_price)
+
+# BTC Price
+
+![Because bitcoin is awesome!](http://media.coindesk.com/2014/03/47660272.jpg)
+
+## What does it do?
+
+From within your Code (or really any) directory, run:
+
+`git clone git@github.com:mecampbellsoup/btc_price.git`;
+
+then:
+
+`cd btc_price`.
+
+If you do not have the [`memcached`](https://github.com/evan/memcached) gem, go get it:
+
+`gem install memcached`.
+
+Next, start (and immediately background) your cache process with:
+
+`memcached -p 11211 &`;
+
+and finally you can run the gem's executable:
+
+`btc_price`.
+
+You should see some content in STDOUT like this:
+
+```bash
+External services status: Good.
+Current BTC price: $622.21.
+```
+
+If you run the executable again (`btc_price`), you'll notice it's much faster. This is because the library uses [`memcached`](https://github.com/evan/memcached) to cache the BTC price and avoid making redundant API requests.
+
+# Why did I write this library?
+
+I wrote this small library initially to learn about caching and how to implement it in Ruby.
+
+We started using a text file for caching and later on switched to `Memcached`.
+
+I like to hack on this on the weekends in order to improve my OOP and design skills.

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rake/testtask'
+
+Rake::TestTask.new :test do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+  t.libs << 'lib'
+  t.libs << 'spec'
+  t.verbose = true
+end
+
+task default: :test

data/bin/btc_price

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$:.push("lib")
+
+require "btc_price"
+
+puts BtcPrice::Runner.run

data/btc_price.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'btc_price/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "btc_price"
+  spec.version       = BtcPrice::VERSION
+  spec.authors       = ["Matt Campbell"]
+  spec.email         = ["mecampbell25@gmail.com"]
+  spec.summary       = %q{Gem for grabbing BTC price from CLI. Also send yourself email price alerts.}
+  spec.description   = <<-DESC
+Use this gem for BTC price discovery; you can also configure
+email notifications at price levels of your choosing.
+  DESC
+  spec.homepage      = ""
+  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"]
+
+  spec.add_runtime_dependency "memcached", "~> 1.8"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.3"
+  spec.add_development_dependency "mocha", "~> 1.1"
+  spec.add_development_dependency "pry", "~> 0.9"
+  spec.add_development_dependency "minitest", "~> 5.3"
+end

data/lib/btc_price.rb

@@ -0,0 +1,9 @@
+require "btc_price/version"
+require "btc_price/cache"
+require "btc_price/coinbase_gateway"
+require "btc_price/runner"
+require "btc_price/services_health"
+require "btc_price/price"
+
+module BtcPrice
+end

data/lib/btc_price/cache.rb

@@ -0,0 +1,35 @@
+require 'memcached'
+
+$cache = Memcached.new("localhost:11211")
+
+module BtcPrice
+  class Cache
+    def initialize(backend)
+      @backend = backend
+    end
+
+    def current_price
+      begin
+        read
+      rescue Memcached::NotFound
+        write
+      end
+    end
+
+    def clear
+      $cache.delete 'price'
+    end
+
+    private
+
+    def read
+      $cache.get 'price'
+    end
+
+    def write
+      price = @backend.current_price
+      $cache.set 'price', price
+      price
+    end
+  end
+end

data/lib/btc_price/coinbase_gateway.rb

@@ -0,0 +1,20 @@
+require 'open-uri'
+require 'json'
+
+module BtcPrice
+  class CoinbaseGateway
+    def current_price
+      JSON(read_request_price)['subtotal']['amount'].to_f
+    end
+
+    private
+
+    def request_price
+      open('https://coinbase.com/api/v1/prices/sell')
+    end
+
+    def read_request_price
+      request_price.read
+    end
+  end
+end

data/lib/btc_price/price.rb

@@ -0,0 +1,15 @@
+module BtcPrice
+  class Price
+    def self.adapter
+      @adapter ||= Cache.new(CoinbaseGateway.new)
+    end
+
+    def self.adapter=(new_adapter)
+      @adapter = new_adapter
+    end
+
+    def self.current_price
+      adapter.current_price
+    end
+  end
+end

data/lib/btc_price/runner.rb

@@ -0,0 +1,8 @@
+module BtcPrice
+  class Runner
+    def self.run
+      "External services status: #{(ServicesHealth.new.healthy? ? 'Good.' : 'Bad.')}"\
+      "\nCurrent BTC price: $#{sprintf("%.2f", Price.current_price)}."
+    end
+  end
+end

data/lib/btc_price/services_health.rb

@@ -0,0 +1,23 @@
+module BtcPrice
+  class ServicesHealth
+    class CoinbaseApiError < StandardError ; end
+
+    def healthy?
+      # Check if Coinbase API is available
+      begin
+        response = CoinbaseGateway.new.send(:request_price)
+      rescue OpenURI::HTTPError => error
+        raise CoinbaseApiError, error.io
+      end
+
+      check_status(response)
+    end
+
+    private
+
+    def check_status(response)
+      # Inspect the response status
+      response.status.first == "200" ? true : false
+    end
+  end
+end

data/lib/btc_price/version.rb

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

data/spec/lib/cache_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+module BtcPrice
+  class MockCoinbaseGateway
+    attr_reader :fetch_counter
+
+    def initialize
+      @fetch_counter = 0
+    end
+
+    def current_price
+      @fetch_counter += 1
+      500
+    end
+  end
+
+  describe Cache do
+    before do
+      $cache = $cache.clone
+      @gateway = MockCoinbaseGateway.new
+      @cache = Cache.new(@gateway)
+      begin
+        @cache.clear
+      rescue Memcached::NotFound
+      end
+    end
+
+    after do
+      @cache.clear
+    end
+
+    it "hits the external service when the cache is 'cold'" do
+      # stub API call; check return value of fetch, i.e. that it equals the stubbed API call
+      @cache.current_price.must_equal 500  
+      # now the 3rd party API gets hit
+    end
+
+    it "does not hit the external service when the cache is 'warm'" do
+      @cache.current_price.must_equal 500
+      @cache.current_price.must_equal 500
+      @gateway.fetch_counter.must_equal 1
+    end
+  end
+end

data/spec/lib/coinbase_gateway_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+module BtcPrice
+  class TestCoinbaseGateway < CoinbaseGateway
+    def read_request_price
+      "{\"subtotal\":{\"amount\":\"511.03\",\"currency\":\"USD\"},\"fees\":[{\"coinbase\":{\"amount\":\"5.11\",\"currency\":\"USD\"}},{\"bank\":{\"amount\":\"0.15\",\"currency\":\"USD\"}}],\"total\":{\"amount\":\"505.77\",\"currency\":\"USD\"},\"amount\":\"505.77\",\"currency\":\"USD\"}"
+    end
+  end
+
+  describe CoinbaseGateway do
+    it "returns the current BTC price" do
+      gateway = TestCoinbaseGateway.new
+      gateway.current_price.must_equal 511.03
+    end
+  end
+end

data/spec/lib/integration_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe "bin/btc_price" do
+  it "prints price" do
+    `btc_price`.to_i.must_be_close_to(500, 5000)
+  end
+end

data/spec/lib/price_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+require 'ostruct'
+
+module BtcPrice
+  describe Price do
+    before do
+      Price.adapter = OpenStruct.new(current_price: 492)
+    end
+
+    it "returns the current BTC price" do
+      Price.current_price.must_equal 492
+    end
+  end
+end

data/spec/lib/runner_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+module BtcPrice
+  describe Runner do
+    describe ".run" do
+      describe "when external services are healthy" do
+        before do
+          ServicesHealth.any_instance.expects(:healthy?).returns(true)
+          Price.expects(:current_price).returns(500)
+        end
+
+        it "returns a string containing a good health report and BTC price when services are available" do
+          string = Runner.run
+          string.must_match(/Good/)
+          string.must_match(/500/)
+        end
+      end
+
+      describe "when external services are not healthy" do
+        it "returns a string containing a bad health report when services aren't available" do
+          ServicesHealth.any_instance.expects(:healthy?).returns(false)
+          Runner.run.must_match(/Bad/)
+        end
+      end
+    end
+  end
+end

data/spec/lib/services_health_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+module BtcPrice
+  describe ServicesHealth do
+    describe "#healthy?" do
+      describe "when services are not healthy" do
+        it "raises an exception when a server error is encountered" do
+          error = OpenURI::HTTPError.new(503, "Service Unavailable")
+          CoinbaseGateway.any_instance.expects(:request_price).raises error
+          err = -> { ServicesHealth.new.healthy? }.must_raise ServicesHealth::CoinbaseApiError 
+          err.message.must_match(/Service Unavailable/)
+        end
+
+        it "returns false when status code is not 200/OK" do
+          response = stub(status: ["400", "Bad Request"])
+          CoinbaseGateway.any_instance.expects(:request_price).returns(response)
+          ServicesHealth.new.healthy?.must_equal false
+        end
+      end
+
+      describe "when response status is 200" do
+        it "returns true" do
+          response = stub(status: ["200", "OK"])
+          CoinbaseGateway.any_instance.expects(:request_price).returns(response)
+          ServicesHealth.new.healthy?.must_equal true
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'btc_price'
+require 'minitest/autorun'
+require 'minitest/pride'
+require 'minitest/unit'
+require 'mocha/mini_test'
+require 'pry'

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: btc_price
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Matt Campbell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: memcached
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.3'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.3'
+description: |
+  Use this gem for BTC price discovery; you can also configure
+  email notifications at price levels of your choosing.
+email:
+- mecampbell25@gmail.com
+executables:
+- btc_price
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/btc_price
+- btc_price.gemspec
+- lib/btc_price.rb
+- lib/btc_price/cache.rb
+- lib/btc_price/coinbase_gateway.rb
+- lib/btc_price/price.rb
+- lib/btc_price/runner.rb
+- lib/btc_price/services_health.rb
+- lib/btc_price/version.rb
+- spec/lib/cache_spec.rb
+- spec/lib/coinbase_gateway_spec.rb
+- spec/lib/integration_spec.rb
+- spec/lib/price_spec.rb
+- spec/lib/runner_spec.rb
+- spec/lib/services_health_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Gem for grabbing BTC price from CLI. Also send yourself email price alerts.
+test_files:
+- spec/lib/cache_spec.rb
+- spec/lib/coinbase_gateway_spec.rb
+- spec/lib/integration_spec.rb
+- spec/lib/price_spec.rb
+- spec/lib/runner_spec.rb
+- spec/lib/services_health_spec.rb
+- spec/spec_helper.rb
+has_rdoc: