engiven 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '08bb5243acb2061c18e7e6751f700265379487c33daeb07559b03bf7baa5c463'
+  data.tar.gz: c831fa60265ab8b2b67ab4c80aa48b3bb4edfa3362d442a2ea11b82064f27c5f
+SHA512:
+  metadata.gz: 5ce36461834c680df2c1cb2f9e4cf17290fe903d04610eea726f5a95b2d4629837482b8aa6a336039f9295274828f2299d7cf3ed5a8db1c00e534168939f137a
+  data.tar.gz: b806b02da1b82a922e23a28f5ae0b1b2969d606cd98120fbe93a12a4eb07c64c10c950dccbffdad33d8374155c3d9112317e799292e876736cb090c36d5340e4

data/.gitignore

@@ -0,0 +1,56 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,28 @@
+PATH
+  remote: .
+  specs:
+    engiven (0.0.1)
+      faraday
+      json
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    faraday (2.6.0)
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (3.0.1)
+    json (2.6.2)
+    rake (13.0.6)
+    ruby2_keywords (0.0.5)
+
+PLATFORMS
+  arm64-darwin-21
+
+DEPENDENCIES
+  bundler
+  engiven!
+  rake
+
+BUNDLED WITH
+   2.3.19

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Taylor Brooks
+
+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,50 @@
+# engiven-api
+A Ruby wrapper for the Engiven.com API
+
+Learn about the Engiven API at https://apidocs.engiven.com
+
+### Installation
+Add this line to your application's Gemfile:
+````ruby
+  # in your Gemfile
+  gem 'engiven', '~> 0.0.1'
+
+  # then...
+  bundle install
+````
+
+### Usage
+````ruby
+  api_key = 'YOUR_API_KEY_HERE'
+  client = EngivenAPI::Client.new(api_key: api_key)
+
+  # List Customers
+  client.list_customers(params)
+
+  # Create a Customer
+  client.create_customer(params)
+
+  # Find a Customer
+  client.find_customer(id)
+
+  # Update a Customer
+  client.update_customer(id, params)
+
+  # List Funds
+  client.list_funds(params)
+
+  # Create a Fund
+  client.create_fund(params)
+
+  # Find a Fund
+  client.find_fund(id)
+
+  # Update a Fund
+  client.update_fund(id, params)
+
+  # List Gifts
+  client.list_gifts(params)
+
+  # Create a Pledged Gift
+  client.create_pledged_gift(params)
+````

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler/gem_tasks'
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ''
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "engiven #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/engiven.gemspec

@@ -0,0 +1,26 @@
+$:.push File.expand_path('../lib', __FILE__)
+require 'engiven/version'
+require 'base64'
+
+Gem::Specification.new do |s|
+  s.name          = 'engiven'
+  s.version       = EngivenAPI::VERSION
+  s.authors       = ['Taylor Brooks']
+  s.email         = ['dGJyb29rc0BnbWFpbC5jb20='].map { |e| Base64.decode64(e) }
+  s.homepage      = 'https://github.com/taylorbrooks/engiven-api'
+  s.summary       = 'A Ruby wrapper for the Engiven API'
+  s.description   = 'A Ruby wrapper for the Engiven API -- a service for accepting cryptocurrency donations.'
+  s.license       = 'MIT'
+
+  s.files         = `git ls-files`.split($/)
+  s.executables   = s.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test)/})
+
+  s.require_paths = ['lib']
+
+  s.add_runtime_dependency     'faraday'
+  s.add_runtime_dependency     'json'
+
+  s.add_development_dependency 'bundler'
+  s.add_development_dependency 'rake'
+end

data/lib/engiven/client.rb

@@ -0,0 +1,65 @@
+require 'faraday'
+
+require './lib/engiven/version'
+require './lib/engiven/resources/customer'
+require './lib/engiven/resources/fund'
+require './lib/engiven/resources/gift'
+
+module EngivenAPI
+  class Client
+    include EngivenAPI::Client::Customer
+    include EngivenAPI::Client::Fund
+    include EngivenAPI::Client::Gift
+
+    attr_reader :api_key, :test_mode, :logger, :connection, :adapter, :ssl
+
+    def initialize(api_key:, test_mode: false, logger: true, adapter: Faraday.default_adapter, ssl: nil)
+      @api_key = api_key
+      @test_mode = test_mode
+      @logger = logger
+      @adapter = adapter
+    end
+
+    def delete(path, options = {})
+      connection.delete(path, options).body
+    end
+
+    def get(path, options = {})
+      connection.get(path, options).body
+    end
+
+    def post(path, options = {})
+      connection.post(path, options).body
+    end
+
+    private
+
+    def url
+      return 'https://api.sandbox.engiven.com' if test_mode
+
+      'https://api.engiven.com'
+    end
+
+    def connection
+      headers = {
+        accept: 'application/json',
+        'Authorization' => api_key,
+        'User-Agent' => "engiven-api-ruby-gem/v#{EngivenAPI::VERSION}",
+      }
+
+      client_opts = {
+        url: url,
+        headers: headers
+      }
+
+      client_opts[:ssl] = ssl if ssl
+
+      Faraday.new(client_opts) do |conn|
+        conn.request  :json
+        conn.response :logger if logger
+        conn.response :json
+        conn.adapter  adapter
+      end
+    end
+  end
+end

data/lib/engiven/resources/customer.rb

@@ -0,0 +1,29 @@
+module EngivenAPI
+  class Client
+    module Customer
+      def list_customers(options = {})
+        get('/customers', options)
+      end
+
+      def create_customer(options = {})
+        post('/customers', options)
+      end
+
+      def find_customer(id)
+        get("/customers/#{id}")
+      end
+
+      def update_customer(id, options = {})
+        post("/customers/#{id}", options)
+      end
+
+      def upload_logo(id, options)
+        post("/customers/#{id}/logo", options)
+      end
+
+      def remove_logo(id)
+        post("/customers/#{id}/logo")
+      end
+    end
+  end
+end

data/lib/engiven/resources/fund.rb

@@ -0,0 +1,21 @@
+module EngivenAPI
+  class Client
+    module Fund
+      def list_funds(options = {})
+        get('/funds', options)
+      end
+
+      def create_fund(options = {})
+        post('/funds', options)
+      end
+
+      def find_fund(id)
+        get("/funds/#{id}")
+      end
+
+      def update_fund(id, options = {})
+        post("/funds/#{id}", options)
+      end
+    end
+  end
+end

data/lib/engiven/resources/gift.rb

@@ -0,0 +1,13 @@
+module EngivenAPI
+  class Client
+    module Gift
+      def list_gifts(options = {})
+        get('/gifts', options)
+      end
+
+      def create_pledged_gift(options = {})
+        post('/gifts', options)
+      end
+    end
+  end
+end

data/lib/engiven/version.rb

@@ -0,0 +1,3 @@
+module EngivenAPI
+  VERSION = '0.0.1'.freeze
+end

data/lib/engiven.rb

@@ -0,0 +1,4 @@
+require './lib/engiven/client'
+
+module EngivenAPI
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: engiven
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Taylor Brooks
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-10-11 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Ruby wrapper for the Engiven API -- a service for accepting cryptocurrency
+  donations.
+email:
+- tbrooks@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- engiven.gemspec
+- lib/engiven.rb
+- lib/engiven/client.rb
+- lib/engiven/resources/customer.rb
+- lib/engiven/resources/fund.rb
+- lib/engiven/resources/gift.rb
+- lib/engiven/version.rb
+homepage: https://github.com/taylorbrooks/engiven-api
+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: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: A Ruby wrapper for the Engiven API
+test_files: []