docproof 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4150cefcec59c38ceb8a97b03e3f266c691c051c
+  data.tar.gz: 0ce2ca3659b30ac78487da2ba5a016270b31a206
+SHA512:
+  metadata.gz: dd8ff23df2b4ac0175443478e5157c89b15a5161036887edebc80f3b18ad5a2a6e26ebca4f5398ac631710afe970d37e736a06bba891b5970bdb4f9cab8f39c9
+  data.tar.gz: 9964dcf7b3d1d19cb4d48e1902602a41497eded31b40f10618d6c1a86e87135ef688c5ccdc1df2f56abcdcb35c2cb8be87c36487977706d37c14d6e3971542a8

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.simplecov

@@ -0,0 +1,5 @@
+SimpleCov.start do
+  add_filter '/test/'
+  add_filter '/.bundle/'
+end
+

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.14.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at ixandidu@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Ikhsan Maulana
+
+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,62 @@
+# Docproof [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://raw.githubusercontent.com/ixandidu/docproof/master/LICENSE.md) [![Gem](https://img.shields.io/gem/v/docproof.svg?style=flat-square)](https://rubygems.org/gems/docproof) [![Code Climate](https://codeclimate.com/github/ixandidu/docproof/badges/gpa.svg)](https://codeclimate.com/github/ixandidu/docproof)
+
+Client library for [Proof of Existence API](https://proofofexistence.com/developers).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'docproof'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install docproof
+
+## Configuration
+
+Currently the only supported Bitcoin Payment Gateway is [Coinbase](https://github.com/coinbase/coinbase-ruby), so if you want to use the `Docproof::Document#notarize!` you'll need to set the following environment variables:
+
+    COINBASE_API_KEY=YOUR-COINBASE-API-KEY
+    COINBASE_API_SECRET=YOUR-COINBASE-API-SECRET
+
+and requires `coinbase/wallet`
+
+```ruby
+require 'coinbase/wallet`
+
+docproof_document = Docproof::Document.new('y0urd0cum3nt5ha256h45h') 
+```
+
+## Usage
+
+To register a new document's SHA256 digest:
+
+```ruby
+doc.register!
+```
+
+To post the document's SHA256 digest to the blockchain (making payment to indicated bitcoind address):
+
+```ruby
+doc.notarize!
+```
+
+To lookup the status of the document's SHA256 digest:
+
+```ruby
+doc.lookup!
+```
+
+## Response
+
+The JSON response is stored in `Docproof::Document#response` and keys with the value of empty string are ignored.
+
+### Errors
+
+If the request is not successful, the gem will raise an error. All errors are subclasses of `Docproof::Document::Errors`.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "docproof"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/docproof.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'docproof/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "docproof"
+  spec.version       = Docproof::VERSION
+  spec.authors       = ["Ikhsan Maulana"]
+  spec.email         = ["ixandidu@gmail.com"]
+
+  spec.summary       = %q{Client library for Proof of Existence API}
+  spec.description   = %q{Client library for Proof of Existence API}
+  spec.homepage      = "https://github.com/ixandidu/docproof"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "webmock", "~> 2.3.2"
+  spec.add_development_dependency "sinatra", "~> 1.4.8"
+  spec.add_development_dependency "simplecov", "~> 0.13.0"
+end

data/exe/docproof

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+require "docproof"

data/lib/docproof/document.rb

@@ -0,0 +1,63 @@
+module Docproof
+  class Error < StandardError; end
+
+  class Document
+    class Existed < Error; end
+    class Invalid < Error; end
+    class NotFound < Error; end
+    class AlreadyNotarized < Error; end
+
+    require 'net/http'
+    require 'json'
+
+    REGISTER_ENDPOINT = URI('https://proofofexistence.com/api/v1/register')
+    STATUS_ENDPOINT   = URI('https://proofofexistence.com/api/v1/status')
+
+    attr_reader :sha256_hash,
+                :response
+
+    def initialize(sha256_hash)
+      @sha256_hash = sha256_hash
+    end
+
+    def register!
+      post(REGISTER_ENDPOINT)
+
+      if response['reason'] == 'existing'
+        raise Existed, "\"#{sha256_hash}\" already registered"
+      end
+
+      if response['reason'] && response['reason'][/Invalid/]
+        raise Invalid, "\"#{sha256_hash}\" is invalid"
+      end
+
+      response
+    end
+
+    def lookup!
+      post(STATUS_ENDPOINT)
+
+      if response['reason'] == 'nonexistent'
+        raise NotFound, "\"#{sha256_hash}\" does not existed."
+      end
+
+      response
+    end
+
+    def notarize!
+      if response['tx']
+        raise AlreadyNotarized, "\"#{sha256_hash}\" is already notarized."
+      end
+
+      PaymentProcessor.new(response).perform!
+    end
+
+    private
+
+      def post(uri)
+        @response = JSON.parse(
+          Net::HTTP.post_form(uri, d: sha256_hash).body
+        ).delete_if { |_, value| value == '' }
+      end
+  end
+end

data/lib/docproof/mocks/fixtures/register/existing.json

@@ -0,0 +1,5 @@
+{
+  "success" : false,
+  "reason"  : "existing",
+  "digest"  : "15db6dbff590000ea13246e1c166802b690663c4e0635bfca78049d5a8762832"
+}

data/lib/docproof/mocks/fixtures/register/invalid.json

@@ -0,0 +1,3 @@
+{
+  "reason" : "Invalid `hash` field"
+}

data/lib/docproof/mocks/fixtures/register/valid.json

@@ -0,0 +1,6 @@
+{
+  "success"     : "true",
+  "digest"      : "15db6dbff590000ea13246e1c166802b690663c4e0635bfca78049d5a8762832",
+  "pay_address" : "1Zmxnd5CmLqhVnCbEcvxNxCoeqa2qhun3",
+  "price"       : 500000
+}

data/lib/docproof/mocks/fixtures/status/confirmed.json

@@ -0,0 +1,11 @@
+{
+  "digest"          : "15db6dbff590000ea13246e1c166802b690663c4e0635bfca78049d5a8762832",
+  "payment_address" : "1Zmxnd5CmLqhVnCbEcvxNxCoeqa2qhun3",
+  "pending"         : false,
+  "timestamp"       : "2015-09-28 18:16:50",
+  "tx"              : "f8db93646769eaf614cf5f26fb1bf1b78ee3f83ba6bebb5f7da9223f0022577d",
+  "txstamp"         : "2015-09-28 18:26:31",
+  "network"         : "livenet",
+  "success"         : true,
+  "blockstamp"      : "2015-09-28 19:32:54"
+}

data/lib/docproof/mocks/fixtures/status/nonexistent.json

@@ -0,0 +1,4 @@
+{
+  "success" : false,
+  "reason"  : "nonexistent"
+}

data/lib/docproof/mocks/fixtures/status/pending.json

@@ -0,0 +1,10 @@
+{
+  "digest"          : "15db6dbff590000ea13246e1c166802b690663c4e0635bfca78049d5a8762832",
+  "payment_address" : "1Zmxnd5CmLqhVnCbEcvxNxCoeqa2qhun3",
+  "pending"         : true,
+  "timestamp"       : "2015-09-28 18:16:50",
+  "network"         : "livenet",
+  "success"         : true,
+  "txstamp"         : "",
+  "blockstamp"      : ""
+}

data/lib/docproof/mocks/fixtures/status/registered.json

@@ -0,0 +1,11 @@
+{
+  "digest"          : "15db6dbff590000ea13246e1c166802b690663c4e0635bfca78049d5a8762832",
+  "payment_address" : "1Zmxnd5CmLqhVnCbEcvxNxCoeqa2qhun3",
+  "pending"         : false,
+  "timestamp"       : "2015-09-28 18:16:50",
+  "tx"              : "f8db93646769eaf614cf5f26fb1bf1b78ee3f83ba6bebb5f7da9223f0022577d",
+  "txstamp"         : "2015-09-28 18:26:31",
+  "network"         : "livenet",
+  "success"         : true,
+  "blockstamp"      : ""
+}

data/lib/docproof/mocks/helper_methods.rb

@@ -0,0 +1,10 @@
+module Docproof
+  module Mocks
+    module HelperMethods
+      def json_file(file_name)
+        File.open(File.expand_path("fixtures/#{file_name}.json", __dir__))
+      end
+    end
+  end
+end
+

data/lib/docproof/mocks/proof_of_existence.rb

@@ -0,0 +1,29 @@
+module Docproof
+  module Mocks
+    module ProofOfExistence
+      require 'sinatra/base'
+
+      class FakeAPI < Sinatra::Base
+        include Docproof::Mocks::HelperMethods
+
+        post '/api/v1/:end_point' do
+          content_type :json
+
+          @@simulations ||= []
+          if params['d'].start_with?('sequence') && @@simulations.empty?
+            @@simulations = params['d'].split('_').reverse
+            @@simulations.pop
+          end
+          params_digest = @@simulations.any? ? @@simulations.pop : params['d']
+          file_name     = "#{params['end_point']}/#{params_digest}"
+
+          # The Proof of Existence API will only response with "400 Bad Request"
+          # when we `register` an invalid sha256 hash.
+          status params_digest[/invalid/] ? 400 : 200
+
+          json_file file_name
+        end
+      end
+    end
+  end
+end

data/lib/docproof/mocks.rb

@@ -0,0 +1,7 @@
+require 'docproof/mocks/helper_methods'
+require 'docproof/mocks/proof_of_existence'
+
+module Docproof
+  module Mocks
+  end
+end

data/lib/docproof/payment_processor.rb

@@ -0,0 +1,46 @@
+module Docproof
+  class PaymentProcessor
+    class MissingDependency < Error; end
+    class MissingCredentials < Error; end
+
+    BTC_IN_SATOSHIS      = 100_000_000
+    MINIMUM_PRICE_IN_BTC = 0.005
+
+    attr_reader :bitcoin_address,
+                :price_in_btc
+
+    def initialize(options={})
+      @bitcoin_address = options['pay_address'] || options['payment_address']
+
+      # `price` given by the API is in satoshis (100_000_000 satoshis = 1 BTC)
+      # and it is only available after successfully `register!` a document.
+      @price_in_btc = MINIMUM_PRICE_IN_BTC
+      @price_in_btc = options['price'].to_f / BTC_IN_SATOSHIS if options['price']
+    end
+
+    def perform!
+      coinbase_wallet_primary_account.send(
+        to:       bitcoin_address,
+        amount:   price_in_btc,
+        currency: 'BTC'
+      )
+    end
+
+    private
+
+      def coinbase_wallet_primary_account
+        require 'coinbase/wallet'
+
+        Coinbase::Wallet::Client.new(
+          api_key:    ENV.fetch('COINBASE_API_KEY'),
+          api_secret: ENV.fetch('COINBASE_API_SECRET')
+        ).primary_account
+      rescue LoadError
+        raise MissingDependency,
+              'Coinbase is required, You can install it with: `gem install coinbase`'
+      rescue KeyError
+        raise MissingCredentials,
+              'Please set `COINBASE_API_KEY` and `COINBASE_API_SECRET` environment variables'
+      end
+  end
+end

data/lib/docproof/version.rb

@@ -0,0 +1,3 @@
+module Docproof
+  VERSION = "0.1.1"
+end

data/lib/docproof.rb

@@ -0,0 +1,7 @@
+require "docproof/version"
+require "docproof/document"
+require "docproof/payment_processor"
+
+module Docproof
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: docproof
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Ikhsan Maulana
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.2
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.8
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+description: Client library for Proof of Existence API
+email:
+- ixandidu@gmail.com
+executables:
+- docproof
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".simplecov"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- docproof.gemspec
+- exe/docproof
+- lib/docproof.rb
+- lib/docproof/document.rb
+- lib/docproof/mocks.rb
+- lib/docproof/mocks/fixtures/register/existing.json
+- lib/docproof/mocks/fixtures/register/invalid.json
+- lib/docproof/mocks/fixtures/register/valid.json
+- lib/docproof/mocks/fixtures/status/confirmed.json
+- lib/docproof/mocks/fixtures/status/nonexistent.json
+- lib/docproof/mocks/fixtures/status/pending.json
+- lib/docproof/mocks/fixtures/status/registered.json
+- lib/docproof/mocks/helper_methods.rb
+- lib/docproof/mocks/proof_of_existence.rb
+- lib/docproof/payment_processor.rb
+- lib/docproof/version.rb
+homepage: https://github.com/ixandidu/docproof
+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.5.2
+signing_key: 
+specification_version: 4
+summary: Client library for Proof of Existence API
+test_files: []