satoshi-unit 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f4078d5c7fe2449c56978ce61a22df23d34bc906
+  data.tar.gz: b1ca344599ad41967fc1347d78f14f97bb522bfa
+SHA512:
+  metadata.gz: ad99e9d1dafcf2103a294cf87ad09e37da2f87f98575dc7f8d9875fdcb5093a4b7c8b2034a65c482f4fdfae5eb6517a9bdc0f85a0c8093accaa5389f2509ce2b
+  data.tar.gz: cd2366b082ac389c1e62ae377ca035c2a07ed4bf91cd0a12e7310da5e618bb780fdf0f584c6d6d6837f16d058f4391f083844e26aad91f718170e78e2ea87a69

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,7 @@
+source "http://rubygems.org"
+
+group :development do
+  gem "bundler", "~> 1.0"
+  gem "jeweler", "~> 2.0.1"
+  gem "rspec"
+end

data/Gemfile.lock

@@ -0,0 +1,65 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.3.6)
+    builder (3.2.2)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.2.5)
+    faraday (0.9.0)
+      multipart-post (>= 1.2, < 3)
+    git (1.2.6)
+    github_api (0.11.3)
+      addressable (~> 2.3)
+      descendants_tracker (~> 0.0.1)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 1.2)
+      multi_json (>= 1.7.5, < 2.0)
+      nokogiri (~> 1.6.0)
+      oauth2
+    hashie (2.1.1)
+    highline (1.6.21)
+    jeweler (2.0.1)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+    json (1.8.1)
+    jwt (1.0.0)
+    mini_portile (0.6.0)
+    multi_json (1.10.1)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nokogiri (1.6.2.1)
+      mini_portile (= 0.6.0)
+    oauth2 (0.9.4)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.5.2)
+    rake (10.3.2)
+    rdoc (4.1.1)
+      json (~> 1.4)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.8)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.6)
+    thread_safe (0.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0)
+  jeweler (~> 2.0.1)
+  rspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Roman Snitko
+
+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,63 @@
+Satoshi Unit
+================
+This tiny gem allows you to make easy conversions from one Bitcoin denomination into another.
+It provides a class, which objects would essentially represent an amount of bitcoins measured
+in the smallest possible denomination, which is Satoshi. You can then call methods on these objects
+to convert it various other denominations.
+
+Here's how it might look:
+
+    s = Satoshi.new(1) # By default, it accepts amounts in BTC denomination
+    s.to_i             # => 100000000 (in Satoshis)
+    s.to_mbtc          # => 1000.0
+    s.to_btc           # => 1.0
+    
+When creating a Satoshi object, you can also specify which unit is being used to pass the amount,
+for example:
+
+    s = Satoshi.new(1, from_unit: :mbtc)
+    
+    s.to_i    # => 100000
+    s.to_mbtc # => 1.0
+    s.to_btc  # => 0.001
+    
+There's also a special method which is called `#to_unit`, it always converts to the denomination
+specified in the `:to_unit` option in the constructor. It becomes really handy when you want to
+specify your preferred denomination used througout the program in just one place
+(to be able to change it later):
+
+    DENOMINATION = :mbtc
+    s = Satoshi.new(1, from_unit: DENOMINATION, from_unit: DENOMINATION)
+    s.to_unit # => 1.0 (in mBTC)
+    
+This can be shortened to just the `:unit` option:
+
+    s = Satoshi.new(1, unit: DENOMINATION)
+    
+But, of course, if you want your "from" denomination and "to" denomination to be different, then
+you'd have to pass them both manually:
+
+    s = Satoshi.new(1, from_unit: :mbtc, to_unit: :btc)
+    s.to_unit # => 0.001
+
+
+
+###Comparing satoshis
+
+Satoshi objects come with methods and coercions for comparing itself with both other Satoshi objects and also numeric values:
+
+    s1 = Satoshi.new(1)
+    s2 = Satoshi.new(2)
+    
+    s1 > s2  # => false
+    s1 < s2  # => true
+    s1 == s2 # => false
+    
+    s1 > 1  # => true
+    1  > s2 # => false
+
+
+### Unit tests
+
+
+Run `rspec spec`. Pull requests with more unit tests are welcome.

data/Rakefile

@@ -0,0 +1,26 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = "satoshi-unit"
+  gem.homepage = "http://github.com/snitko/satoshi-unit"
+  gem.license = "MIT"
+  gem.summary = %Q{Converts various bitcoin denominations in Satoshis and back}
+  gem.description = %Q{Converts various bitcoin denominations in Satoshis and back}
+  gem.email = "roman.snitko@gmail.com"
+  gem.authors = ["Roman Snitko"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/satoshi.rb

@@ -0,0 +1,96 @@
+class Satoshi
+
+  # Says how many digits after the decimal point
+  # a denomination has.
+  UNIT_DENOMINATIONS = {
+    btc:     8,
+    mbtc:    5,
+    satoshi: 0
+  }
+
+  attr_reader :value, :from_unit, :to_unit
+
+  def initialize(n=nil, from_unit: 'btc', to_unit: 'btc', unit: nil)
+    if unit
+      @from_unit = @to_unit = unit.downcase.to_sym
+    else
+      @from_unit = from_unit.downcase.to_sym
+      @to_unit   = to_unit.downcase.to_sym
+    end
+    @value = convert_to_satoshi(n) if n
+  end
+
+  def to_btc
+    to_denomination(UNIT_DENOMINATIONS[:btc])
+  end
+
+  def to_mbtc
+    to_denomination(UNIT_DENOMINATIONS[:mbtc])
+  end
+
+  def to_unit
+    to_denomination(UNIT_DENOMINATIONS[@to_unit])
+  end
+
+  def to_i
+    @value
+  end
+  alias :satoshi_value :to_i 
+
+  def value=(n)
+    @value = convert_to_satoshi(n)
+  end
+
+  def satoshi_value=(v)
+    @value = v
+  end
+
+  def >(i)
+    self.to_i > i
+  end
+
+  def <(i)
+    self.to_i < i
+  end
+
+  def ==(i)
+    self.to_i == i
+  end
+
+  def +(i)
+    self.to_i + i
+  end
+
+  def -(i)
+    self.to_i - i
+  end
+
+  def coerce(other)
+    if other.kind_of?(Integer)
+      [other, self.to_i]
+    else
+      raise TypeError, message: "Satoshi cannot be coerced into anything but Integer"
+    end
+  end
+
+  private
+  
+    def to_denomination(digits_after_delimiter)
+      return @value if digits_after_delimiter <= 0
+      leading_zeros = "0"*(18-@value.to_s.length)
+      result = leading_zeros + @value.to_s
+      result.reverse!
+      result = result.slice(0..digits_after_delimiter-1) + '.' + result.slice(digits_after_delimiter..17)
+      result.reverse!
+      result.sub(/\A0*/, '').sub(/0*\Z/, '').to_f # remove zeros on both sides
+    end
+
+    def convert_to_satoshi(n)
+      n = ("%.#{UNIT_DENOMINATIONS[@from_unit]}f" % n) # otherwise we might see a scientific notation
+      n = n.split('.') 
+      n[1] ||= '' # in the case where there's no decimal part
+      n[1] += "0"*(UNIT_DENOMINATIONS[@from_unit]-n[1].length) if n[1] 
+      n.join.to_i
+    end
+
+end

data/spec/satoshi_spec.rb

@@ -0,0 +1,32 @@
+require_relative '../lib/satoshi'
+
+describe Satoshi do
+
+  it "creates a Bignum representing value in satoshi units" do
+    expect(Satoshi.new(1.00).to_i).to eq(100000000)
+  end
+
+  it "takes care of the sign before the value" do
+    expect(Satoshi.new(-1.00).to_i).to eq(-100000000)
+  end
+
+  it "converts satoshi unit back to some more common denomination" do
+    expect(Satoshi.new(1.00).to_btc).to eq(1)
+    expect(Satoshi.new(1.08763).to_btc).to eq(1.08763)
+    expect(Satoshi.new(1.08763).to_mbtc).to eq(1087.63)
+    expect(Satoshi.new(-1.08763).to_mbtc).to eq(-1087.63)
+    expect(Satoshi.new(0.00000001).to_i).to eq(1)
+    expect(Satoshi.new(0.00000001).to_mbtc).to eq(0.00001)
+  end
+   
+  it "converts from various source denominations" do
+    expect(Satoshi.new(1, unit: 'mbtc').to_btc).to      eq(0.001)
+    expect(Satoshi.new(1, unit: 'mbtc').to_unit).to     eq(1)
+    expect(Satoshi.new(10000000, unit: 'mbtc').to_unit).to eq(10000000)
+    satoshi = Satoshi.new(10000000, unit: 'mbtc')
+    satoshi.satoshi_value = 1
+    expect(satoshi.to_unit).to eq(0.00001)
+    expect(Satoshi.new(100, unit: 'mbtc').to_i).to eq(10000000)
+  end
+
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: satoshi-unit
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Roman Snitko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+description: Converts various bitcoin denominations in Satoshis and back
+email: roman.snitko@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/satoshi.rb
+- spec/satoshi_spec.rb
+homepage: http://github.com/snitko/satoshi-unit
+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: Converts various bitcoin denominations in Satoshis and back
+test_files: []