hostedhooks 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 589ce3bf7f35913ded48306ae3d4ec7a9424c9c351b773e189e0cc5fb0fae4ec
+  data.tar.gz: f746e4e7f92460b9b087a2fdaddbaa9baf96f9648736326f17440525c89f6642
+SHA512:
+  metadata.gz: 38a3988a0930be8cf7a1e17828e393a20086e13e5b90b57663dccd8a350909c6e70570664f9b58cf540c6ec18a7ddeb2f9909a4f8b57a306dd8fd81646f769af
+  data.tar.gz: 9a4270c7d3a75b704e5681e61bc3258d7105a49d037d2b3a4e35e4474bf6492d876b4683f13ff643f89e42cb1f202806a6c261565ebab0fed878a3134f3cfbc7

data/.gitignore

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

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 ian.grabill@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 [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in hostedhooks-ruby.gemspec
+gemspec
+
+gem "rake", "~> 12.0"

data/Gemfile.lock

@@ -0,0 +1,27 @@
+PATH
+  remote: .
+  specs:
+    hostedhooks (0.1.0)
+      httparty
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    httparty (0.18.1)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2021.0225)
+    multi_xml (0.6.0)
+    rake (12.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  hostedhooks!
+  rake (~> 12.0)
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -0,0 +1,64 @@
+# HostedHooks Ruby Gem
+
+A Ruby library for [HostedHooks](https://www.hostedhooks.com) - a Webhooks as a Service Platform
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hostedhooks'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install hostedhooks
+
+## How it works
+
+### Authentication
+
+Initialize the gem with your API key [found here](https://www.hostedhooks.com/settings/account).
+
+     client = HostedHooks::Client.new('API_KEY')
+
+### Get one record
+
+    client.get_endpoint("endpoint_uuid")
+
+
+### Get a collection of records
+
+
+    client.list_subscriptions("app_uuid")
+
+### Create a record
+
+    client.create_app(name: "Test App Name")
+
+### Update a record
+
+    client.update_app("app_uuid", name: "Test App Name")
+
+
+## Resources
+
+* Apps
+* Subscriptions
+* Endpoints
+* Webhook Events
+* Messages
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/hostedhooks-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/HostedHooks/hostedhooks-ruby/blob/master/CODE_OF_CONDUCT.md).
+
+
+## Code of Conduct
+
+Everyone interacting in the Hostedhooks::Ruby project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/HostedHooks/hostedhooks-ruby/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 "hostedhooks"
+
+# 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/hostedhooks.gemspec

@@ -0,0 +1,26 @@
+require_relative 'lib/hostedhooks/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hostedhooks"
+  spec.version       = HostedHooks::VERSION
+  spec.authors       = ["Ian Grabill"]
+  spec.email         = ["ian@hostedhooks.com"]
+
+  spec.summary       = %q{A ruby library for the HostedHooks API}
+  spec.homepage      = "https://github.com/HostedHooks/hostedhooks-ruby"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+  spec.metadata["homepage_uri"] = spec.homepage
+
+  # 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_dependency "httparty"
+end

data/lib/hostedhooks/client.rb

@@ -0,0 +1,116 @@
+module HostedHooks
+
+  class Client
+
+    def initialize(api_key = nil)
+      @api_key = api_key || ENV["HOSTEDHOOKS_API_KEY"]
+    end
+
+    # Apps
+
+    def list_apps
+      get_response("/apps")
+    end
+
+    def create_app(payload = {})
+      post_response "/apps", payload.slice(:name)
+    end
+
+    def update_app(uuid, payload = {})
+      patch_response "/apps/#{uuid}", payload.slice(:name)
+    end
+
+    # Subscriptions
+
+    def get_subscription(uuid)
+      get_response "/subscriptions/#{uuid}"
+    end
+
+    def list_subscriptions(app_uuid)
+      get_response("/apps/#{app_uuid}/subscriptions")
+    end
+
+    def create_subscription(app_uuid, payload = {})
+      post_response "/apps/#{app_uuid}/subscriptions", payload.slice(:name)
+    end
+
+    # Endpoints
+
+    def get_endpoint(app_uuid, endpoint_uuid)
+      get_response "/apps/#{app_uuid}/endpoints/#{endpoint_uuid}"
+    end
+
+    def list_endpoints(app_uuid)
+      get_response("/apps/#{app_uuid}/endpoints")
+    end
+
+    def create_subscription(subscription_uuid, payload = {})
+      post_response "/subscriptions/#{subscription_uuid}/endpoints", payload.slice(:url, :enabled_events, :version, :status, :description)
+    end
+
+    def update_app(subscription_uuid, endpoint_uuid, payload = {})
+      patch_response "/subscriptions/#{subscription_uuid}/endpoints/#{endpoint_uuid}", payload.slice(:url, :enabled_events, :version, :status, :description)
+    end
+
+    # Webhook Events
+
+    def list_webhook_events(app_uuid)
+      get_response("/apps/#{app_uuid}/webhook_events")
+    end
+
+    # Messages
+
+    def create_app_message(app_uuid, payload = {})
+      post_response "/apps/#{app_uuid}/messages", payload.slice(:event_type, :data, :version, :event_id)
+    end
+
+    def create_subscription_message(subscription_uuid, payload = {})
+      post_response "/subscriptions/#{subscription_uuid}/messages", payload.slice(:event_type, :data, :version, :event_id)
+    end
+
+    def create_endpoint_message(subscription_uuid, endpoint_uuid, payload = {})
+      post_response "/subscriptions/#{subscription_uuid}/endpoints/#{endpoint_uuid}/messages", payload.slice(:event_type, :data, :version, :event_id)
+    end
+
+    private
+
+    HOSTEDHOOKS_API_ENDPOINT = "https://hostedhooks.com/api/v1"
+
+    def get_response(url)
+    	response = HTTParty.get("#{HOSTEDHOOKS_API_ENDPOINT}#{url}", timeout: 3, headers: { 'Authorization' => "Bearer #{@api_key}" })
+      body = JSON.parse(response.body)
+      return {"error" => body['message'], "code" => response.code} if response.code >= 400
+      return body
+    end
+
+    def post_response(url, payload)
+    	response = HTTParty.post("#{HOSTEDHOOKS_API_ENDPOINT}#{url}",
+    		body: payload.to_json,
+    		timeout: 3,
+    		headers: {
+    			'Authorization' => "Bearer #{@api_key}",
+    			'Content-Type' => 'application/json'
+    		}
+    	)
+      body = JSON.parse(response.body)
+    	return {"error" => body['message'], "code" => response.code} if response.code >= 400
+    	return body
+    end
+
+    def patch_response(url, payload)
+    	response = HTTParty.patch("#{HOSTEDHOOKS_API_ENDPOINT}#{url}",
+    		body: payload.to_json,
+    		timeout: 3,
+    		headers: {
+    			'Authorization' => "Bearer #{@api_key}",
+    			'Content-Type' => 'application/json'
+    		}
+    	)
+      body = JSON.parse(response.body)
+      return {"error" => body['message'], "code" => response.code} if response.code >= 400
+      return body
+    end
+
+  end
+
+end

data/lib/hostedhooks/version.rb

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

data/lib/hostedhooks.rb

@@ -0,0 +1,10 @@
+require "httparty"
+require "openssl"
+require "base64"
+require "hostedhooks/version"
+require "hostedhooks/client"
+
+module HostedHooks
+  class Error < StandardError; end
+
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: hostedhooks
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ian Grabill
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-08-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  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:
+email:
+- ian@hostedhooks.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- hostedhooks.gemspec
+- lib/hostedhooks.rb
+- lib/hostedhooks/client.rb
+- lib/hostedhooks/version.rb
+homepage: https://github.com/HostedHooks/hostedhooks-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/HostedHooks/hostedhooks-ruby
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: A ruby library for the HostedHooks API
+test_files: []