bitcoin-money 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7bbd47f91a4b3a01fcdf4be0f27aff9a3a2a8408
+  data.tar.gz: 8db8423a57535504626f5b4f22b5ff62e809a210
+SHA512:
+  metadata.gz: 98300ed09cb6b940238fde4e44eb99439e01921208499772af1b53e8427221022607081b3a9652c766f227c1ad6a333bfbec6f67ada87c313e5abf1e3f6754ba
+  data.tar.gz: 5bd7136a7a0d78cdf6abd198c8d173839336e3c3bf64d794274bf2f32720591667620c95ceccfc1ad0cc7b4672ee8cfaf9aab75ec0d88b88950f24aad78635cb

data/.gitignore

@@ -0,0 +1,23 @@
+*.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
+.idea

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 James Larisch
+
+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,60 @@
+# Bitcoin Money!
+
+The Money gem is a popular gem for Ruby. 
+Ruby needs a gem like Money, for Bitcoin!
+
+But BTC is unique, so this simple object should be unique.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'bitcoin-money'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bitcoin-money
+
+## Usage
+
+Require it! 
+
+`require 'btc'`
+
+Create from whichever unit of BTC.
+~~~ruby
+a = Btc.new(0.012) 
+b = Btc.from_mbtc(12)
+c = Btc.from_satoshis(120000)
+a == b # true
+b == c # true
+# a == b == c
+~~~
+
+Get value in any unit of BTC.
+~~~ruby
+b # => #<Btc BTC:0.012 mBTC: 12.0 Satoshis: 120000.0>
+b.mbtc # => BigDecimal.new('12.0')
+b.satoshis # => BigDecimal.new('120000.0')
+b.btc # => BigDecimal.new('0.012')
+~~~
+
+Perform operations.
+~~~ruby
+a + b # == Bitcoin.new(0.024)
+a * a # == Bitcoin.new(0.000144)
+a / c # == Bitcoin.new(1)
+# also ** and -
+~~~
+
+## Contributing
+
+1. Fork it ( https://github.com/zenchilabs/bitcoin-money/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,2 @@
+require "bundler/gem_tasks"
+

data/bitcoin-money.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "bitcoin-money"
+  spec.version       = "0.1.0"
+  spec.authors       = ["James Larisch"]
+  spec.email         = ["root@jameslarisch.com"]
+  spec.summary       = "Represent BTC like Money, with nice precision."
+  spec.description   = "Represent BTC like Money, with nice precision."
+  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{^(spec|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 3.0.0"
+
+end

data/lib/btc.rb

@@ -0,0 +1,74 @@
+require 'bigdecimal'
+
+class Btc
+  SATOSHI = BigDecimal.new('0.00000001')
+  MBTC = BigDecimal.new('0.0001')
+  BTC = BigDecimal.new('1.0')
+
+  def initialize(amt)
+    raise ArgumentError, 'BTC amount must not be less than 0.00000001' unless Btc.valid_btc(amt)
+    @amt = BigDecimal.new(amt.to_f.to_s)
+  end
+
+  def self.from_mbtc(amt)
+    raise ArgumentError, 'mBTC amount must not be less than 0.00001' unless Btc.valid_mbtc(amt)
+    Btc.new(BigDecimal.new(amt.to_f.to_s) * MBTC)
+  end
+
+  def self.from_satoshis(amt)
+    raise ArgumentError, 'Satoshi amount must be > 1 or 0' unless Btc.valid_satoshis(amt)
+    Btc.new(BigDecimal.new(amt.to_i.to_f.to_s) * SATOSHI)
+  end
+
+  def self.valid_satoshis(amt)
+    amt.to_i >= 0
+  end
+
+  def self.valid_mbtc(amt)
+    amt.to_f >= MBTC.to_f || amt.to_f == 0
+  end
+
+  def self.valid_btc(amt)
+    amt.to_f >= SATOSHI.to_f || amt.to_f == 0
+  end
+
+  def btc
+    @amt
+  end
+
+  def mbtc
+    @amt / MBTC
+  end
+
+  def satoshis
+    @amt / SATOSHI
+  end
+
+  def +(other)
+    Btc.new(@amt + other.btc)
+  end
+
+  def /(other)
+    Btc.new(@amt / other.btc)
+  end
+
+  def -(other)
+    Btc.new(@amt - other.btc)
+  end
+
+  def *(other)
+    Btc.new(@amt * other.btc)
+  end
+
+  def **(exp)
+    Btc.new(@amt ** exp)
+  end
+
+  def ==(other)
+    @amt == other.btc
+  end
+
+  def inspect
+    "#<Btc BTC:#{btc} mBTC:#{mbtc} Satoshis:#{satoshis}>"
+  end
+end

data/spec/btc_spec.rb

@@ -0,0 +1,58 @@
+require 'btc'
+
+describe Btc do
+
+  it 'should initialize okay' do
+    b = Btc.new(12345)
+    expect(b.btc).to eq(BigDecimal.new('12345.0'))
+  end
+
+  it 'should throw error if invalid btc amount' do
+    expect{ Btc.new(0.00000000000001) }.to raise_error(ArgumentError)
+  end
+
+  it 'should throw error if invalid mbtc amount' do
+    expect{ Btc.from_mbtc(Btc::SATOSHI) }.to raise_error(ArgumentError)
+  end
+
+  it 'should throw error if invalid satoshi amount' do
+    expect{ Btc.from_satoshis(-1) }.to raise_error(ArgumentError)
+  end
+
+  it 'should convert btc to mbtc and back' do
+    expect(Btc.new(Btc::MBTC.to_f).mbtc).to eq(BigDecimal.new('1'))
+    expect(Btc.from_mbtc(1).btc).to eq(BigDecimal.new(Btc::MBTC))
+  end
+
+  it 'should convert btc to satoshis and back' do
+    expect(Btc.new(Btc::SATOSHI).satoshis).to eq(BigDecimal.new('1'))
+    expect(Btc.from_satoshis(1).btc).to eq(BigDecimal.new(Btc::SATOSHI))
+  end
+
+  it 'should convert mbtc to satoshis and back' do
+    expect(Btc.from_mbtc(1).satoshis).to eq(BigDecimal.new('10000'))
+    expect(Btc.from_satoshis(1000).mbtc).to eq(BigDecimal.new('0.1'))
+  end
+
+  it 'should use equality correctly' do
+    expect(Btc.new(0.1234)).to eq(Btc.from_mbtc(1234))
+    expect(Btc.new(0.1234)).to eq(Btc.from_satoshis(12340000))
+    expect(Btc.from_mbtc(12)).to eq(Btc.from_satoshis(120000))
+  end
+
+  it 'should use multiplication correctly' do
+    expect(Btc.new(0.1234) * Btc.new(0.1234)).to eq(Btc.new(BigDecimal.new('0.1234') * BigDecimal.new('0.1234')))
+  end
+
+  it 'should use division correctly' do
+    expect(Btc.new(0.1234) / Btc.new(0.1234)).to eq(Btc.new(BigDecimal.new('0.1234') / BigDecimal.new('0.1234')))
+  end
+
+  it 'should use addition correctly' do
+    expect(Btc.new(0.1234) + Btc.new(0.1234)).to eq(Btc.new(BigDecimal.new('0.1234') + BigDecimal.new('0.1234')))
+  end
+
+  it 'should use subtraction correctly' do
+    expect(Btc.new(0.1234) - Btc.new(0.1234)).to eq(Btc.new(BigDecimal.new('0.1234') - BigDecimal.new('0.1234')))
+  end
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: bitcoin-money
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- James Larisch
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: Represent BTC like Money, with nice precision.
+email:
+- root@jameslarisch.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bitcoin-money.gemspec
+- lib/btc.rb
+- spec/btc_spec.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: Represent BTC like Money, with nice precision.
+test_files:
+- spec/btc_spec.rb