books-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 56c312777264b990552b33b49fe6469a5f801fd9
+  data.tar.gz: c9200f4d03f6fec2e1c2f2141017940532eedc76
+SHA512:
+  metadata.gz: 919ad1c847dfc49c3dcdf3c0646b153ad96c920e99470fb80e803b6f35978aa81db023de44aa79b26c0ab639e189428d5bd3a9058d4d0ff9489f2aeac11ae30d
+  data.tar.gz: 95a7e4e2f304266680b6f50d821dc0e6bf346dd59c3ad6dc539b96dae1d236bdbb75bfedcadfcb9471a307e82d8b84acedaf1d829443eafa1e55554fff9c017b

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+README.md
+ChangeLog.md
+
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,5 @@
+/.bundle
+/Gemfile.lock
+/html/
+/pkg/
+/vendor/cache/*.gem

data/.rdoc_options

@@ -0,0 +1,16 @@
+--- !ruby/object:RDoc::Options
+encoding: UTF-8
+static_path: []
+rdoc_include:
+  - .
+charset: UTF-8
+exclude: 
+hyperlink_all: false
+line_numbers: false
+main_page: README.md
+markup: markdown
+show_hash: false
+tab_width: 8
+title: books-ruby Documentation
+visibility: :protected
+webcvs:

data/.rspec

@@ -0,0 +1 @@
+--colour --format documentation

data/.ruby-version

@@ -0,0 +1 @@
+2.4.4

data/ChangeLog.md

@@ -0,0 +1,4 @@
+### 0.1.0 / 2018-04-16
+
+* Initial release:
+

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://gems.vip.global.square/'
+source 'https://gems.vip.global.square/private/'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2018 abishopric
+
+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,27 @@
+# books-ruby
+
+* [Homepage](https://rubygems.org/gems/books-ruby)
+* [Documentation](http://rubydoc.info/gems/books-ruby/frames)
+* [Email](mailto:abishopric at squareup.com)
+
+## Description
+
+TODO: Description
+
+## Features
+
+## Examples
+
+    require 'books'
+
+## Requirements
+
+## Install
+
+    $ gem install books-ruby
+
+## Copyright
+
+Copyright (c) 2018 abishopric
+
+See LICENSE.txt for details.

data/Rakefile

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+require 'rubygems'
+
+begin
+  require 'bundler/setup'
+rescue LoadError => e
+  abort e.message
+end
+
+require 'rake'
+
+
+require 'rubygems/tasks'
+Gem::Tasks.new
+
+require 'rdoc/task'
+RDoc::Task.new
+task :doc => :rdoc
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+task :test    => :spec
+task :default => :spec

data/books-ruby.gemspec

@@ -0,0 +1,47 @@
+# -*- encoding: utf-8 -*-
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'books/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "books-ruby"
+  gem.version       = Books::VERSION
+  gem.summary       = "Books Ruby SDK"
+  gem.description   = "Interact with Books in Ruby"
+  gem.license       = "MIT"
+  gem.authors       = ["abishopric"]
+  gem.email         = "abishopric@squareup.com"
+  gem.homepage      = "https://stash.corp.squareup.com/projects/SQ/repos/books-ruby/browse"
+
+  gem.files         = `git ls-files`.split($/)
+
+  `git submodule --quiet foreach --recursive pwd`.split($/).each do |submodule|
+    submodule.sub!("#{Dir.pwd}/",'')
+
+    Dir.chdir(submodule) do
+      `git ls-files`.split($/).map do |subpath|
+        gem.files << File.join(submodule,subpath)
+      end
+    end
+  end
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.required_ruby_version = '>= 2.4.4'
+
+  gem.add_dependency 'sq-common'
+  gem.add_dependency 'sq-protos'
+  gem.add_dependency 'sq-p2'
+  gem.add_dependency 'square_connector'
+  gem.add_dependency 'ed25519'
+
+  gem.add_development_dependency 'bundler', '~> 1.10'
+  gem.add_development_dependency 'pry'
+  gem.add_development_dependency 'rake', '~> 10.0'
+  gem.add_development_dependency 'rdoc', '~> 4.0'
+  gem.add_development_dependency 'rspec', '~> 3.0'
+  gem.add_development_dependency 'rubygems-tasks', '~> 0.2'
+  gem.add_development_dependency 'rubocop'
+end

data/lib/books.rb

@@ -0,0 +1,4 @@
+require 'books/version'
+
+require 'books/client'
+require 'books/fake_authority_client'

data/lib/books/client.rb

@@ -0,0 +1,128 @@
+require 'sq/protos'
+require 'ed25519'
+require 'base64'
+
+require 'squareup/books/service.pb'
+require 'squareup/booksauthority/service.pb'
+
+module Books
+  class StandardClient
+    attr_reader :books_client, :books_authority_client, :eddsa_private_key, :eddsa_public_key
+
+    #
+    # Instantiate a new client that can connect to Books.
+    #
+    # ** eddsa_public_key_path and eddsa_private_key_path (required) ** :
+    #    Both are paths to your eddsa keys you intend to use to sign journal entries.
+    #    The private key will be used to sign journal entries as they are sent, while
+    #    the public key can be used to verify journal entries afterwards. Note that
+    #    these are generally not the same keys used to intitiate TLS.
+    #
+    # ** connector ** :
+    #    A connector from which we can request the clients "books" and "booksAuthority".
+    #    This is only required if either books_client or books_authority_client
+    #    are not provided. Connectors are provided by the square_connector gem or from
+    #    sq/common.
+    #
+    # ** books_client and books_authority_client (optional) ** :
+    #    RPC clients that would otherwise be provided by the connector. Helpful for testing.
+    #    If provided, will take precedence over what would have been returned by the connector
+    #
+    def initialize(books_client: nil,
+      books_authority_client: nil,
+      connector: nil,
+      eddsa_public_key_path:,
+      eddsa_private_key_path:)
+      @books_client = books_client || begin
+        fail "Neither connector nor books_client given" unless connector
+        books_http_client = connector.create(:books)
+        Sq::Protos::RpcClient.new(books_http_client, Squareup::Books::Service::BooksService)
+      end
+
+      @books_authority_client = books_authority_client || begin
+        fail "Neither connector nor books_authority_client given" unless connector
+        books_authority_http_client = connector.create(:booksAuthority)
+        Sq::Protos::RpcClient.new(books_authority_http_client,
+          Squareup::Booksauthority::Service::BooksAuthorityService)
+      end
+
+      @eddsa_private_key = Ed25519::SigningKey.new(extract_key(eddsa_private_key_path, "ED25519 PRIVATE KEY"))
+      @eddsa_public_key_data = File.read(eddsa_public_key_path) # want PEM format
+      @eddsa_public_key = Ed25519::VerifyKey.new(extract_key(eddsa_public_key_path, "ED25519 PUBLIC KEY"))
+    end
+
+    def get_books_matching(req)
+      @books_client.https_rpc(:get_books_matching, req)
+    end
+
+    def register_myself
+      register_client({
+        public_key: @eddsa_public_key_data
+      })
+    end
+
+    def register_client(req)
+      @books_client.https_rpc(:register_client, req)
+    end
+
+    def create_denomination(req)
+      @books_client.https_rpc(:create_denomination, req)
+    end
+
+    def create_book(req)
+      bas_response = @books_authority_client.https_rpc(:generate_sskg, {})
+      with_sskg = req.dup
+      with_sskg[:first_sskg_key] = bas_response[:first_key]
+      with_sskg[:root_sskg_token] = bas_response[:root_sskg_token]
+      @books_client.https_rpc(:create_book, with_sskg)
+    end
+
+    def journal(req)
+      raise "Journal entry type not provided" unless req[:journal_entry_type]
+      raise "Journal idempotence token not provided" unless req[:idempotence_token]
+      raise "Journal entries not provided" unless req[:entries] && req[:entries].size > 1
+
+      total = req[:entries].map do |entry|
+        raise "Must set exactly one of to_amount or from_amount" unless (entry[:to_amount] ^ entry[:from_amount])
+        entry[:to_amount] - entry[:from_amount]
+      end.sum
+
+      raise "Total change in book entry amounts is not 0" unless total == 0
+
+      raise "The signature field must not be set (the SDK will assign this field for you)" if req[:signature]
+
+      # sign the request body
+      jreq = Squareup::Books::Service::JournalRequest.new(req)
+
+      encoded_proto = jreq.encode
+      signature = @eddsa_private_key.sign(encoded_proto)
+      req[:signature] = signature
+
+      journal_response = @books_client.https_rpc(:journal, req)
+      if journal_response.status != Squareup::Books::Service::JournalStatus::JOURNAL_SUCCESS
+        raise "Journaling error received: #{journal_resp.status}"
+      end
+      journal_response
+    end
+
+    private
+
+    # Given a filepath, read the file as a PEM file. Assert that
+    # the given header is present in the PEM header and footer.
+    def extract_key(pem_filepath, expected_pem_header)
+      pem_data = File.read(pem_filepath)
+      contents = pem_data.split("\n")
+      raise "Invalid PEM file, too short" unless contents.size > 2
+
+      unless contents[0].include?(expected_pem_header)
+        raise "Header for #{pem_filepath} isn't what we expected. Is it a #{expected_pem_header} ?"
+      end
+      unless contents[contents.length - 1].include?(expected_pem_header)
+        raise "Footer for #{pem_filepath} isn't what we expected. Is it a #{expected_pem_header} ?"
+      end
+
+      base64Encoded = contents[1..contents.size-2].join("")
+      return Base64.decode64(base64Encoded)
+    end
+  end
+end

data/lib/books/fake_authority_client.rb

@@ -0,0 +1,46 @@
+require 'base64'
+
+module Books
+  #
+  # Test class that provides a fake RPC client for books authority.
+  # Useful for tests, it provides real SSKG generation. It does not
+  # do the full suite of verification.
+  #
+  class FakeAuthorityClient
+    def initialize(
+      raise_on_self_register:false,
+      raise_on_verify:false)
+      @sskgs = {}
+      @raise_on_self_register = raise_on_self_register
+    end
+
+    def https_rpc(rpc, req)
+      case rpc
+      when :generate_sskg
+        generate_sskg(req)
+      when :verify_book
+        verify_book(req)
+      when :register_self
+        register_self(req)
+      else
+        raise "Invalid RPC method #{rpc}"
+      end
+    end
+
+    def register_self(req)
+      raise "Client already registered" if @raise_on_self_register
+    end
+
+    def verify_book(req)
+      raise "Book has been tampered with" if @raise_on_verify
+    end
+
+    def generate_sskg(req)
+      {
+        root_sskg_token: Base64.decode64("gqhwb3NpdGlvbgClbm9kZXORgqVzdGF0ZcQg/z6NXBXEZRXi1qKfcsmSmu5x2HCYgbT9ZC97IVJyqWymaGVpZ2h0Pw=="),
+        first_key: Base64.decode64("gqhwb3NpdGlvbgGlbm9kZXOSgqVzdGF0ZcQgd1N+3oVeOJri1Jz8k0fBHSMv6YejZcT8EjW0ixZwoAOmaGVpZ2h0PoKlc3RhdGXEILIzf84dcqwznf807/8DVWJNE/Pj5MTkILqeTOOCaK3GpmhlaWdodD4="),
+      }
+    end
+
+  end
+end

data/lib/books/version.rb

@@ -0,0 +1,4 @@
+module Books
+  # books-ruby version
+  VERSION = "0.1.0"
+end

data/spec/books_spec.rb

@@ -0,0 +1,97 @@
+require 'spec_helper'
+require 'books'
+require 'pry'
+require 'square_connector'
+require 'securerandom'
+require 'uri'
+
+describe Books do
+  it "should have a VERSION constant" do
+    expect(subject.const_get('VERSION')).to_not be_empty
+  end
+
+  it "should create books and journal end-to-end" do
+    books_host = "https://abishopric.local:32191"
+    client_tls_cert = "/data/app/books/secrets/books-abishopric.local-s2s.crt"
+    client_tls_key = "/data/app/books/secrets/books-abishopric.local-s2s.key"
+    s2s_ca = "/data/app/books/secrets/service2service.ca.pem"
+    client_signing_pubkey = "/Users/abishopric/books/books-abishopric-32-byte-private-key.pub"
+    client_signing_privkey = "/Users/abishopric/books/books-abishopric-32-byte-private-key.priv"
+
+    ################
+
+    connector = SquareConnector::Client.new(
+      services: {
+        books: { url: URI.parse(books_host) },
+      },
+      certs: {
+        client_cert: client_tls_cert,
+        client_key: clinet_tls_key,
+        ca_certificate: s2s_ca,
+      },
+      logger: Logger.new(STDERR),
+      app_name: 'TestApp'
+    )
+    client = Books::StandardClient.new(connector: connector,
+      books_authority_client: FakeAuthorityClient.new,
+      eddsa_public_key_path: client_signing_pubkey,
+      eddsa_private_key_path: client_signing_privkey)
+
+    client.register_myself
+
+    client.create_denomination({
+      full_name: "United States Dollars",
+      short_name: "USD"
+    })
+
+    owner = SecureRandom.hex
+
+    asset_book = client.create_book({
+      denomination: "USD",
+      min_balance: 0,
+      idempotence_token: SecureRandom.hex,
+      contra: false,
+      max_balance: 1000,
+      type: "cash",
+      owner: owner,
+      category: Squareup::Books::Service::BookCategory::ASSET
+    }).book
+
+    expect(asset_book).to_not be_nil
+
+    liability_book = client.create_book({
+      denomination: "USD",
+      max_balance: 0,
+      idempotence_token: SecureRandom.hex,
+      contra: false,
+      min_balance: -1000,
+      type: "cash",
+      owner: owner,
+      category: Squareup::Books::Service::BookCategory::LIABILITY
+    }).book
+
+    response = client.get_books_matching(filter: {
+      :owner => owner
+    })
+
+    expect(response.books.length).to eq(2)
+
+    journal_resp = client.journal({
+      entries: [{
+        to_amount: 100,
+        from_amount: 0,
+        book_id: asset_book.book_id,
+        book_entry_type: "cash_received"
+      }, {
+        from_amount: 100,
+        to_amount: 0,
+        book_id: liability_book.book_id,
+        book_entry_type: "cash_loaned"
+      }],
+      idempotence_token: SecureRandom.hex,
+      journal_entry_type: "loan"
+    })
+
+    expect(journal_resp.status).to eq(Squareup::Books::Service::JournalStatus::JOURNAL_SUCCESS)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'rspec'
+require 'books/version'
+
+include Books

metadata

@@ -0,0 +1,230 @@
+--- !ruby/object:Gem::Specification
+name: books-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- abishopric
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-05-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sq-common
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sq-protos
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sq-p2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: square_connector
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ed25519
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: 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: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubygems-tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: Interact with Books in Ruby
+email: abishopric@squareup.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".document"
+- ".gitignore"
+- ".rdoc_options"
+- ".rspec"
+- ".ruby-version"
+- ChangeLog.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- books-ruby.gemspec
+- lib/books.rb
+- lib/books/client.rb
+- lib/books/fake_authority_client.rb
+- lib/books/version.rb
+- spec/books_spec.rb
+- spec/spec_helper.rb
+homepage: https://stash.corp.squareup.com/projects/SQ/repos/books-ruby/browse
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.4
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14.1
+signing_key: 
+specification_version: 4
+summary: Books Ruby SDK
+test_files:
+- spec/books_spec.rb
+- spec/spec_helper.rb