tipalti 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0c0b548e2ff96d153f37ce3070918e7eb5fdf8a22a79f187917928e980b905c2
+  data.tar.gz: 998041fc9874697f067e4827a5e3860696d65abf14b7303ff276ac11b57066b5
+SHA512:
+  metadata.gz: e9e7d0aea100778e7163c99c22eeb4f03f8e857752613dcd1c596798b6abeae72ccd5640209441f383eb564aea076026cd6feeb0ae198f936d57a46f8b8858d0
+  data.tar.gz: 0c6a9a838ddeafb8c3112ff4c30805242f6d5891943117537db9bdacac8fbee006951c5c0d496a6f2082d5550b256db681a177be9e7d2a202309890ab21c5ad4

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in tipalti.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 MagicLinks
+
+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,56 @@
+# Tipalti Ruby Gem
+
+A Ruby interface for Tipalti Payments.
+
+## Installation
+
+    $ gem install tipalti
+
+## Configuration
+
+Create a configuration file
+
+```ruby
+Tipalti.configure do |config|
+  config.master_key = "xxx"
+  config.url = "https://ui2.sandbox.tipalti.com"
+  config.payer = "MagicLinks"
+end
+```
+
+## Usage Examples
+
+### Tipalti iFrames ###
+
+Tipalti uses iFrames to support end user access to registration, invoices and payments history.
+
+To generate a valid iFrame url:
+
+```ruby
+Tipalti::Iframe.url(user_params)
+```
+__Supported iFrame Parameters__
+
+The only required parameter is a Payee ID (`idap`).
+
+To specify the page to render, send a `page` parameter with one of:
+* `home` (default)
+* `invoices`
+* `payments`
+
+```ruby
+Tipalti::Iframe.url(idap: "user-22579", page: "payments")
+```
+
+All other iFrame parameters supported by Tipalti can be passed as params. See the official documentation for details:
+https://support.tipalti.com/Content/Topics/Development/iFrames/IframeRequestStructure.htm
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/tipalti/configuration.rb

@@ -0,0 +1,9 @@
+module Tipalti
+  class Configuration
+
+    attr_accessor :master_key
+    attr_accessor :url
+    attr_accessor :payer
+
+  end
+end

data/lib/tipalti/iframe.rb

@@ -0,0 +1,19 @@
+module Tipalti
+  class Iframe
+
+    PAGES = {
+      home: "Home",
+      invoices: "Invoices",
+      payments: "PaymentsHistory"
+    }
+
+    # https://support.tipalti.com/Content/Topics/Development/iFrames/IframeRequestStructure.htm
+    def self.url(params = {})
+      page = (params.delete(:page) || "home").to_sym
+      param_str = params.merge(payer: params[:payer] || Tipalti.configuration.payer, ts: Time.now.to_i).to_query
+      hashkey = OpenSSL::HMAC.hexdigest('sha256', Tipalti.configuration.master_key, param_str)
+      "#{Tipalti.configuration.url}/PayeeDashboard/#{PAGES[page]}?#{param_str}&hashkey=#{hashkey}"
+    end
+
+  end
+end

data/lib/tipalti/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Tipalti
+  VERSION = "0.1.0"
+end

data/lib/tipalti.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative "tipalti/configuration"
+require_relative "tipalti/iframe"
+require_relative "tipalti/version"
+
+module Tipalti
+  class << self
+    # Instantiate the Configuration singleton
+    # or return it. Remember that the instance
+    # has attribute readers so that we can access
+    # the configured values
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    # This is the configure block definition.
+    # The configuration method will return the
+    # Configuration singleton, which is then yielded
+    # to the configure block. Then it's just a matter
+    # of using the attribute accessors we previously defined
+    def configure
+      yield(configuration)
+    end
+  end
+end

data/sig/tipalti.rbs

@@ -0,0 +1,4 @@
+module Tipalti
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

data/tipalti.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "lib/tipalti/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "tipalti"
+  spec.version = Tipalti::VERSION
+  spec.authors = ["Aaron Chi"]
+  spec.email = ["aaron.chi@magiclinks.com"]
+
+  spec.summary = "Tipalti toolkit"
+  spec.description = "A Ruby toolkit for Tipalti Payments"
+  spec.homepage = "https://github.com/magiclinkstech/tipalti-ruby"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.5.1"
+
+  #spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
+  #spec.metadata["homepage_uri"] = spec.homepage
+  #spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+  #spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: tipalti
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aaron Chi
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-12-08 00:00:00.000000000 Z
+dependencies: []
+description: A Ruby toolkit for Tipalti Payments
+email:
+- aaron.chi@magiclinks.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/tipalti.rb
+- lib/tipalti/configuration.rb
+- lib/tipalti/iframe.rb
+- lib/tipalti/version.rb
+- sig/tipalti.rbs
+- tipalti.gemspec
+homepage: https://github.com/magiclinkstech/tipalti-ruby
+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.5.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: Tipalti toolkit
+test_files: []