alloy-api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6d37d96928f05bb171b47d67433c9699fc00c2752f83dfd8b1dd46b74553bdaa
+  data.tar.gz: 5f07aa536199716687e54ee7ae071f55adb655b87ea829738d7449857bb67df5
+SHA512:
+  metadata.gz: 2114d90c96ce86a6fac6bfca74e956610b60f6a4aaabd4e6bf6c54c91fb2ab18aa131067d630e2db34af9a5a7bfb80c98ea494a6b216379af75fadc56c916b7b
+  data.tar.gz: 35ea77c8f8a19c604c1fbdb8a0b2851c0d2c46d522c1862fb65f04a36be5426853ddb55ba647e928297608c4b024b1624d3a8c5e7af563fd5fa77dedd158f1d3

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.0.1 / 2020-06-10
+
+* Initial Release

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright © 2020 Matthew Schultz
+
+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,46 @@
+# Alloy API
+A simple gem to wrap Alloy.co's API for doing KYC in ruby applications.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'alloy-api'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install alloy-api
+```
+
+## Usage
+
+Start by requiring the api:
+
+```ruby
+require 'alloy-api'
+```
+
+Then set the token and secret for the workflow to use:
+
+```ruby
+Alloy::Api.api_token = 'provided by the workflow'
+Alloy::Api.api_secret = 'provided by the workflow'
+```
+
+If using Rails, this can be done in either the environment files or an initializer, but remember not to include the raw keys in repositories!
+
+Also, if using a sandbox, set the endpoint:
+
+```ruby
+Alloy::Api.api_uri = 'https://sandbox.alloy.co/' # Be sure to include the trailing slash!
+```
+
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/alloy-api.rb

@@ -0,0 +1,46 @@
+require 'httparty'
+require 'base64'
+require 'json'
+
+module Alloy
+  class Api
+    @@api_uri     = 'https://api.alloy.co/'
+    @@api_token   = nil
+    @@api_secret  = nil
+
+    def self.api_uri=(value)
+      @@api_uri = value
+    end
+
+    def self.api_token=(value)
+      @@api_token = value
+    end
+
+    def self.api_secret=(value)
+      @@api_secret = value
+    end
+
+    def self.method_missing(m, *args, &block)
+      options = args.any? ? args[0] : {}
+      method = options[:method] || "post"
+      uri = "#{@@api_uri}#{m}"
+      headers = {
+        "Content-Type" => "application/json",
+        "Authorization" => auth_param
+      }.merge(options[:headers].to_h)
+
+      JSON.parse(HTTParty.send(method, uri, {headers: headers, body: (options[:body] || {}).to_json}).body)
+      # TODO: Error handling
+    end
+
+    private
+
+    def self.auth_param
+      "Basic #{encoded}"
+    end
+
+    def self.encoded
+      Base64.strict_encode64 "#{@@api_token}:#{@@api_secret}"
+    end
+  end
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: alloy-api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Matthew Schultz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-06-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+description: "    A wrapper for the Alloy.co API. Helps to build KYC policy support
+  into applications.\n"
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/alloy-api.rb
+homepage: https://github.com/MatthewSchultz/alloy-api
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/MatthewSchultz/alloy-api
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A wrapper for the Alloy.co API
+test_files: []