strike-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 28abee578aa20697a967724cc355e2dede734381
+  data.tar.gz: 147dae48150828b776a44fca36f12503677d6960
+SHA512:
+  metadata.gz: ca2928bb9e83b7dd4f13b6ca5b2c9aeb8ad9616189b8280961d56cf671f95b3bf91b18ac3e69c821695fb64a4ae72992525df9ae0af538235a12d15c1c97f2cd
+  data.tar.gz: 0e460a369e21bea2983ec0f57a4cb97e78be10961e986ddd64c734bac687f352b14afdf420b50d39f0088984344d95eee9c40819e2d30f3843e3d93c31171201

data/.gitignore

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

data/.travis.yml

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

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 ted.price@centro.net. 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,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in strike-ruby.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,42 @@
+PATH
+  remote: .
+  specs:
+    strike-ruby (0.1.0)
+      faraday
+      json
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    faraday (0.15.3)
+      multipart-post (>= 1.2, < 3)
+    hashdiff (0.3.5)
+    json (2.1.0)
+    minitest (5.11.3)
+    multipart-post (2.0.0)
+    public_suffix (3.0.3)
+    rake (10.5.0)
+    safe_yaml (1.0.4)
+    vcr (3.0.3)
+    webmock (2.3.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  minitest (~> 5.0)
+  rake (~> 10.0)
+  strike-ruby!
+  vcr
+  webmock
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Ted Price
+
+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,89 @@
+# Strike-Ruby
+
+This is a Ruby API Wrapper for the [Strike](https://strike.acinq.co/) bitcoin
+payments API.
+
+### Installing
+
+System Gems:
+```
+gem install strike-ruby
+```
+
+or Gemfile:
+```
+gem 'strike-ruby'
+
+```
+
+## Usage
+
+```
+# /path/to/config.rb
+Strike::Client.strike_api_env="test" || "live"
+Strike::Client.strike_api_key="key from strike"
+```
+or
+```
+# use ENV['STRIKE_API_KEY'] and ENV['STRIKE_API_ENV']
+Strike::Client.use_environment_variables
+```
+
+then use
+```
+# /some/sweet/lightning/app.rb
+
+require "strike" # notice this is "strike" not "strike-ruby"
+
+Strike::Client.strike_api_key = "sk_foo"
+Strike::Client.strike_api_env = "test"
+
+# List first 30 charges
+Strike::Charge.all # identical to Strike::Charge.all(page: 1, per_page: 30)
+# => [#<Strike::Charge:0x00007fb231184300 @id="ch_1jSMVtGiDptw8NQKB6GXTVYA1YJZZ", @amount=42000, @amount_satoshi=42000, @currency="btc", @description="1%20Blockaccino", @customer_id="This is a random test field", @payment_request="lntb520u1pd75atvpp5ntvt72p326r8mhyxeteujsu0p968zu3zfmf6zpvuva8nkr477qaqdqcxyjnyvzzd3hkx6mpvd3kjmn0cqp2qn9cl9hzjjzck6czwrskd0etnq5cjhsjndvlckzvp0hkt02vlhzjxr3raak4jcdkude3v4g8zr4g2ukzkqfjz7n4zvgsqz6qyk7rqxcpa2la7x", @paid=false, @created=1542092140171, @updated=1542092140171, @code=nil, @message=nil>...]
+
+# List 50 results on page 2
+Strike::Charge.all(page: 2, per_page: 50)
+[...]
+
+# Find by id
+Strike::Charge.find("ch_1jSMVtGiDptw8NQKB6GXTVYA1YJZZ")
+# => #<Strike::Charge:0x00007fb243344300 @id="ch_1jSMVtGiDptw8NQKB6GXTVYA1YJZZ", @amount=42000, @amount_satoshi=42000, @currency="btc", @description="1%20Blockaccino", @customer_id="This is a random test field", @payment_request="lntb520u1pd75atvpp5ntvt72p326r8mhyxeteujsu0p968zu3zfmf6zpvuva8nkr477qaqdqcxyjnyvzzd3hkx6mpvd3kjmn0cqp2qn9cl9hzjjzck6czwrskd0etnq5cjhsjndvlckzvp0hkt02vlhzjxr3raak4jcdkude3v4g8zr4g2ukzkqfjz7n4zvgsqz6qyk7rqxcpa2la7x", @paid=false, @created=1542092140171, @updated=1542092140171, @code=nil, @message=nil>
+
+# Create charge
+Strike::Charge.create(amount: 42_000, currency: "btc", description: "The Times 03/Jan/2009 Chancellor on brink of second bailout for banks", customer_id: "optional text for tracking")
+# => #<Strike::Charge:0x00007fea209216e0 @id="ch_3vymhqec4RZQVfKQtCKH5j3R6yv7u", @amount=42000, @amount_satoshi=42000, @currency="btc", @description="The Times 03/Jan/2009 Chancellor on brink of second bailout for banks", @customer_id="option text for identifying user", @payment_request="lntb420u1pd7hgr4pp5lt8hz548pnutq0z0zcxfsj2j9yu9kn4crzvnhwj5r4228thuzwvsdr0235x2gz5d9kk2ueqxqej7jnpdchnyvps8ysyx6rpde3k2mrvdaezqmmwyp38y6twdvsx7e3qwdjkxmmwvssxyctfd3hh2apqvehhygrzv9hxkuccqp2ev87r57en5smqqjaztv6x6hyddmg8q6e7j4at9prz4w0uz9auymy9ry3jjf7k75h40njgzd7gj5z3rspr9qaq3jhgtyzjfqfep5fracq43wt30", @paid=false, @created=1542168693183, @updated=1542168693183, @code=nil, @message=nil>
+
+# Error!
+# Strike::Charge.find("foo")
+# => #<Strike::Charge:0x00007ff7649cd368 @id=nil, @amount=nil, @amount_satoshi=nil, @currency=nil, @description=nil, @customer_id=nil, @payment_request=nil, @paid=nil, @created=nil, @updated=nil, @code=404, @message="not found">
+```
+
+## Built With
+
+* [webmock](https://github.com/bblimke/webmock)
+* [vcr](https://github.com/vcr/vcr)
+* [faraday](https://github.com/lostisland/faraday)
+* [json](https://github.com/flori/json)
+
+## Contributing
+
+Make a pull request or fork and go!
+
+## Versioning
+
+We use [SemVer](http://semver.org/) for versioning.
+
+## Authors
+
+* **Ted Price ** - *Initial work* - [Stacksimple.io](https://github.com/stacksimple)
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE.txt](LICENSE.txt) file for details
+
+## Acknowledgments
+
+* Hat tip to anyone whose code was used
+* Inspiration
+* etc

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 "strike/ruby"
+
+# 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/lib/strike.rb

@@ -0,0 +1,7 @@
+require "strike/version"
+
+module Strike
+  # Your code goes here...
+  autoload :Client, "strike/client.rb"
+  autoload :Charge, "strike/charge.rb"
+end

data/lib/strike/charge.rb

@@ -0,0 +1,105 @@
+require 'faraday'
+require 'json'
+
+module Strike
+  class Charge
+    PATH = "/api/v1/charges".freeze
+
+    def self.api_url
+      @api_url ||= PATH
+    end
+
+    def self.conn
+      Client.conn
+    end
+
+    attr_accessor :id,  # String Unique identifier of the charge
+      :amount,          # Integer Positive integer in the smallest unit in the currency used.  If the currency is btc, the amount must be in satoshi.
+      :amount_satoshi,  # Integer Amount in satoshi.
+      :currency, #String Currency code associated with the amount. Only btc is supported currently.
+      :description, #String Discretionary description of the charge.
+      :customer_id, #String Optional field, can be used to attach an identifier of your choice to the charge.
+      :payment_request, #String Lightning payment request corresponding to the charge.  This needs to be sent to the user.
+      :paid, #Boolean Indicates whether the charge has been paid or not.
+      :created, #Integer Time at which the charge was created.
+      :updated, #String Time at which the charge was last updated.
+      :code,
+      :message
+
+    attr_reader :error
+
+    def initialize(options)
+      self.id = options["id"]
+      self.amount = options["amount"]
+      self.amount_satoshi = options["amount_satoshi"]
+      self.currency = options["currency"]
+      self.description = options["description"]
+      self.customer_id = options["customer_id"]
+      self.payment_request = options["payment_request"]
+      self.paid = options["paid"]
+      self.created = options["created"]
+      self.updated = options["updated"]
+      self.code = options["code"]
+      self.message = options["message"]
+    end
+
+    def success?
+      code.nil? || code == 200
+    end
+
+    def fail?
+      !success?
+    end
+
+    # Fetch a charge by id
+    #
+    # @param page [Integer] page of results to display
+    # @param per_page [Integer] number of results per page
+    #
+    # returns [Strike::Charge]
+    def self.all(page: 1, per_page: 30)
+      response =
+        conn.get do |req|
+          req.url api_url
+          req.params['page'] = (page - 1).to_i
+          req.params['size'] = per_page.to_i
+        end
+      JSON.parse(response.body).map { |attributes| new(attributes) }
+    end
+
+    # Fetch a charge by id
+    #
+    # @param id [String] ID of Strike charge record
+    #
+    # returns [Strike::Charge]
+    def self.find(id)
+      response = conn.get("#{api_url}/#{id}")
+      new(JSON.parse(response.body))
+    end
+
+    # Create a new Strike charge
+    #
+    # @param amount [Integer]  Positive integer in the smallest unit in the currency used. If the currency is btc, the amount must be in satoshi, and the maximum amount is 4,294,967 satoshis.
+    # @param currency [String] Currency code associated with the amount.  Only btc is supported currently.
+    # @param description [String] Discretionary description of the charge. Must not exceed 256 characters.
+    # @param customer_id [String] This field is optional and can be used to attach an identifier of your choice to the charge. Must not exceed 64 characters.
+    #
+    # returns [Strike::Charge]
+    def self.create(amount:, currency:, description:, customer_id:)
+      body = {
+        amount: amount,
+        currency: currency,
+        description: description,
+        customer_id: customer_id
+      }
+
+      response =
+        conn.post do |req|
+          req.url api_url
+          req.headers['Content-Type'] = 'application/json'
+          req.body = body.to_json
+        end
+      new(JSON.parse(response.body))
+    end
+  end
+end

data/lib/strike/client.rb

@@ -0,0 +1,37 @@
+require 'faraday'
+require 'json'
+
+module Strike
+
+  class Client
+    # Set live url, default anything else to test
+    API_URLS = {
+      live: "https://api.strike.acinq.co".freeze
+    }.tap { |hsh| hsh.default = "https://api.dev.strike.acinq.co".freeze }
+    .freeze
+
+    class << self
+      attr_accessor :strike_api_env, :strike_api_key
+
+      def use_environment_variables
+        self.strike_api_key = ENV['STRIKE_API_KEY']
+        self.strike_api_env = ENV['STRIKE_API_ENV'].downcase
+      end
+
+      def conn
+        return @conn if @conn
+
+        raise "Please set strike_api_key" if (strike_api_key || "").empty?
+
+        @conn = Faraday.new(url: api_url) do |builder|
+          builder.use Faraday::Request::BasicAuthentication, strike_api_key, nil
+          builder.use Faraday::Adapter::NetHttp
+        end
+      end
+
+      def api_url
+        API_URLS[strike_api_env.to_sym]
+      end
+    end
+  end
+end

data/lib/strike/version.rb

@@ -0,0 +1,3 @@
+module Strike
+  VERSION = "0.1.0"
+end

data/strike-ruby.gemspec

@@ -0,0 +1,40 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "strike/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "strike-ruby"
+  spec.version       = Strike::VERSION
+  spec.authors       = ["Ted Price"]
+  spec.email         = ["ted@stacksimple.io"]
+
+  spec.summary       = %q{API Wrapper for Strike (Acinq) Lightning Network API}
+  spec.description   = %q{API Wrapper for Strike (Acinq) Lightning Network API (https://strike.acinq.co/)}
+  spec.homepage      = "https://github.com/stacksimple/strike-ruby"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  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.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
+
+  spec.add_dependency "faraday"
+  spec.add_dependency "json"
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: strike-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ted Price
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-11-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.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: vcr
+  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: webmock
+  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: faraday
+  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: json
+  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'
+description: API Wrapper for Strike (Acinq) Lightning Network API (https://strike.acinq.co/)
+email:
+- ted@stacksimple.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/strike.rb
+- lib/strike/charge.rb
+- lib/strike/client.rb
+- lib/strike/version.rb
+- strike-ruby.gemspec
+homepage: https://github.com/stacksimple/strike-ruby
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.6.14
+signing_key: 
+specification_version: 4
+summary: API Wrapper for Strike (Acinq) Lightning Network API
+test_files: []