petra_sdk 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fad54bff793b834174d982ea856c3d3c9b3b24591d6fa9a870b4c7650282f49d
+  data.tar.gz: c5bba13d72e72aafa61fdd4059da446ed519af6555c3e5c3497f4a7217422ba8
+SHA512:
+  metadata.gz: 21c990a80c15f0dc981d8e8819b14d77fbf170f31060f334243427be4c5d1e0f007efe4b20151d774003de75059a7ea7f6e263d7486d542f7b720a30986e1c36
+  data.tar.gz: 334a08da3f3d9ba783dad6e02f022d178870676617b78e96a7d7d88853ac6a8a1ece7bfd5d2ba96089a742209724ae5a0cca3ba555e7ee20dd15477d7bc34242

data/.gitignore

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

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 Emmanueltolu.adebayo@gmail.com. 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 petra.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Emmanuel Adebayo
+
+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,43 @@
+# Petra
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/petra`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'petra'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install petra
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/petra. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Petra project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/petra/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "petra"
+
+# 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/petra.rb

@@ -0,0 +1,35 @@
+require 'petra/version'
+
+class Petra
+  attr_accessor  :secret_key, :production, :url
+
+  def initialize(secret_key = nil)
+    @secret_key = secret_key
+    petra_base_url = BASE_ENDPOINTS::PETRA_BASE_URL
+    @url = petra_base_url
+
+    def base_url
+      url
+    end
+
+    @secret_key = if secret_key.nil?
+                    ENV['PETRA_SECRET_KEY']
+                  else
+                    secret_key
+                  end
+    warn 'Warning: To ensure your petra account api keys are safe, It is best to always set your keys in the environment variable'
+
+
+
+    # raise this error if no secret key is passed
+    if @secret_key.nil?
+      raise PetraBadKeyError,
+            "No secret key supplied and couldn't find any in environment variables. Make sure to set secret key as an environment variable PETRA_SECRET_KEY"
+    end
+    # raise this error if invalid secret key is passed
+    unless @secret_key[0..7] == 'sk_live' || @secret_key[0..7] == 'sk_test'
+      raise PetraBadKeyError, "Invalid secret key #{@secret_key}"
+    end
+
+  end
+end

data/lib/petra/error.rb

@@ -0,0 +1,15 @@
+class PetraServerError < StandardError
+  attr_reader :response
+  def initialize(response=nil)
+    @response = response
+  end
+end
+
+class PetraBadKeyError < StandardError
+end
+
+class IncompleteParameterError < StandardError
+end
+
+class SuggestedAuthError < StandardError
+end

data/lib/petra/modules/base.rb

@@ -0,0 +1,105 @@
+require "json"
+require_relative '../error'
+
+class Base
+
+  attr_reader :petra_object
+
+  # method to initialize this class
+
+  def initialize(petra_object=nil)
+    unless !petra_object.nil?
+      raise ArgumentError, "Petra Africa Object is required!!!"
+    end
+    @petra_object = petra_object
+  end
+
+
+  def get_request(endpoint)
+    # headers = {
+    #     "Authorization" => "Bearer #{petra_object.secret_key}"
+    # }
+    begin
+      response = HTTParty.get(endpoint, :headers => { "Authorization" => "Bearer #{petra_object.secret_key}" })
+      unless (response.code == 200 || response.code == 201)
+        raise PetraServerError.new(response), "HTTP Code #{response.code}: #{response.body}"
+      end
+
+      return response
+
+      unless(response.code != 0 )
+        raise PetraServerError.new(response), "Server Message: #{response.message}"
+      end
+
+    rescue JSON::ParserError => jsonerr
+      raise PetraServerError.new(response) , "Invalid result data. Could not parse JSON response body \n #{jsonerr.message}"
+      return response
+    end
+  end
+
+
+  # method to make a post request
+  def post_request(endpoint, data)
+    begin
+      response = HTTParty.post(endpoint, {
+        body: data,
+        headers: {
+          "Content-Type" => "application/json",
+          "Authorization" =>  "Bearer #{petra_object.secret_key}"
+        }
+      })
+
+      unless (response.code == 200 || response.code == 201)
+        raise PetraServerError.new(response), "HTTP Code #{response.code}: #{response.body}"
+      end
+      return response
+    end
+
+  end
+  # method to make a put request
+  def put_request(endpoint, data)
+    begin
+      response = HTTParty.put(endpoint, {
+        body: data,
+        headers: {
+          "Content-Type" => "application/json",
+          "Authorization" =>  "Bearer #{petra_object.secret_key}"
+        }
+      })
+
+      unless (response.code == 200 || response.code == 201)
+        raise PetraServerError.new(response), "HTTP Code #{response.code}: #{response.body}"
+      end
+      return response
+    end
+  end
+
+  # method to make a delete request
+  def delete_request(endpoint, data)
+    begin
+      response = HTTParty.delete(endpoint, {
+        body: data,
+        headers: {
+          "Content-Type" => "application/json",
+          "Authorization" =>  "Bearer #{petra_object.secret_key}"
+        }
+      })
+
+      unless (response.code == 200 || response.code == 201)
+        raise PetraServerError.new(response), "HTTP Code #{response.code}: #{response.body}"
+      end
+      return response
+    end
+  end
+
+  # method to check if the passed parameters is equal to the expected parameters
+  def check_passed_parameters(required_params, passed_params)
+
+    # This is used to check if the passed authorization parameters matches the required parameters
+    required_params.each do |k, v|
+      if !passed_params.key?(k)
+        raise IncompleteParameterError, "Parameters Incomplete, Missing Parameter: #{k}, Please pass in the complete parameter."
+      end
+    end
+  end
+end

data/lib/petra/modules/customer.rb

@@ -0,0 +1,34 @@
+require_relative 'base'
+require 'json'
+
+
+class Customer < Base
+
+  def create_customer(data)
+    base_url = petra_object.base_url
+    required_parameters = ["email"]
+    check_passed_parameters(required_parameters, data)
+    response = post_request("#{base_url}/customer", data)
+    return response
+  end
+
+  def get_customers(page, per_page)
+    base_url = petra_object.base_url
+    response = get_request("#{base_url}/customer?perPage=#{per_page}&page=#{page}")
+    return response
+  end
+
+  def get_customer(reference)
+    base_url = petra_object.base_url
+    response = get_request("#{base_url}/customer/#{reference}")
+    return  response
+  end
+
+  def update_customer(reference, payload)
+    base_url = petra_object.base_url
+    required_parameters = ['first_name','last_name']
+    check_passed_parameters(required_parameters, payload)
+    response = put_request("#{base_url}/customer/#{reference}", payload)
+    return  response
+  end
+end

data/lib/petra/modules/endpoints.rb

@@ -0,0 +1,3 @@
+module BASE_ENDPOINTS
+  PETRA_BASE_URL = "https://petra-staging.herokuapp.com"
+end

data/lib/petra/modules/invoice.rb

@@ -0,0 +1,38 @@
+require_relative 'base'
+require 'json'
+
+class Invoice < Base
+
+  def create_invoice(data)
+    base_url = petra_object.base_url
+    required_parameters = ["email","amount"]
+    check_passed_parameters(required_parameters, data)
+    response = post_request("#{base_url}/invoice", data)
+    return response
+  end
+
+  def get_invoices(page,per_page)
+    base_url = petra_object.base_url
+    response = get_request("#{base_url}/invoice?perPage=#{per_page}&page=#{page}")
+    return response
+  end
+
+  def get_invoice(id)
+    base_url = petra_object.base_url
+    response = get_request("#{base_url}/invoice/#{id}")
+    return response
+  end
+
+  def archive_invoice(id)
+    base_url = petra_object.base_url
+    response = get_request("#{base_url}/invoice/archive/#{id}")
+    return response
+  end
+
+  def send_notification(id)
+    base_url = petra_object.base_url
+    payload = {}
+    response = post_request("#{base_url}/invoice/notify/#{id}", payload)
+    return response
+  end
+end

data/lib/petra/modules/page.rb

@@ -0,0 +1,38 @@
+require_relative 'base'
+require 'json'
+
+class Page < Base
+
+  def create_page(data)
+    base_url = petra_object.base_url
+    required_parameters = ["name","amount","description"]
+    check_passed_parameters(required_parameters, data)
+    response = post_request("#{base_url}/page", data)
+    return response
+  end
+
+  def get_pages(page, per_page)
+    base_url = petra_object.base_url
+    response = get_request("#{base_url}/page?perPage=#{per_page}&page=#{page}")
+    return response
+  end
+
+  def get_page(id)
+    base_url = petra_object.base_url
+    response = get_request("#{base_url}/page/#{id}")
+    return  response
+  end
+
+  def update_page(id, payload)
+    base_url = petra_object.base_url
+    required_parameters = ["name"]
+    check_passed_parameters(required_parameters, payload)
+    response = put_request("#{base_url}/page/#{id}", payload)
+  end
+
+  def check_slug_availability(slug)
+    base_url = petra_object.base_url
+    response = get_request("#{base_url}/page/check_slug_availability/#{slug}")
+    return  response
+  end
+end

data/lib/petra/modules/transaction.rb

@@ -0,0 +1,33 @@
+require_relative 'base'
+require 'json'
+
+class Transactions < Base
+
+  def initialize_transaction(data)
+    base_url = petra_object.base_url
+    required_parameters = ["amount", "type", "email"]
+    check_passed_parameters(required_parameters, data)
+    response = post_request("#{base_url}/transaction/initialize", data)
+    return response
+  end
+
+  def get_transactions(page = 1, per_page = 50)
+    base_url = petra_object.base_url
+    response = get_request("#{base_url}/transaction?perPage=#{per_page}&page=#{page}")
+    return response
+  end
+
+  def fetch_transaction(id)
+    base_url = petra_object.base_url
+    response = get_request("#{base_url}/transaction/#{id}")
+    return response
+  end
+
+
+  def verify_transaction(id)
+    base_url = petra_object.base_url
+    response = get_request("#{base_url}/transaction/verify/#{id}")
+    return  response
+  end
+
+end

data/lib/petra/version.rb

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

data/petra.gemspec

@@ -0,0 +1,39 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "petra/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "petra_sdk"
+  spec.version       = Petra::VERSION
+  spec.authors       = ["Emmanuel Adebayo"]
+  spec.email         = ["emmanueltolu.adebayo@gmail.com"]
+
+  spec.summary       = %q{Petra Africa Ruby/Rails Gem.}
+  spec.description   = %q{This is the official Ruby Gem for Petra Africa.}
+  spec.homepage      = "https://github.com/PetraHQ/petra_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["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/PetraHQ/petra_ruby"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # 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(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: petra_sdk
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Emmanuel Adebayo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-08-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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'
+description: This is the official Ruby Gem for Petra Africa.
+email:
+- emmanueltolu.adebayo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".DS_Store"
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/petra.rb
+- lib/petra/error.rb
+- lib/petra/modules/base.rb
+- lib/petra/modules/customer.rb
+- lib/petra/modules/endpoints.rb
+- lib/petra/modules/invoice.rb
+- lib/petra/modules/page.rb
+- lib/petra/modules/transaction.rb
+- lib/petra/version.rb
+- petra.gemspec
+homepage: https://github.com/PetraHQ/petra_ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/PetraHQ/petra_ruby
+  source_code_uri: https://github.com/PetraHQ/petra_ruby
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Petra Africa Ruby/Rails Gem.
+test_files: []