simplyq 0.8.2rc → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4044d212ae7b9cd8952ae0c04499883576efba9b8d3b9b55588aa227465a7a6c
-  data.tar.gz: ac7798ba1b45a305cee54455411554f7e42f1ae4e20505dfa44eb7bc45ca381a
+  metadata.gz: b5567d4d53527951f2a3009d7f97053293935c7cc35e0b58b84bb958dc7c7c7a
+  data.tar.gz: 0a911e6b8b50a80d2c1b72453ca25f03a7ebf31307e9e32f8ed80e25d1243aa1
 SHA512:
-  metadata.gz: d9c27060de2a5626c982db7b619b27db036f75df7d1169851c9ea396e8ef04a5353e96c866f2be2084cbeda7c6dcd6fd21b01b47bd138e6ead6ff646f023dec0
-  data.tar.gz: 2e63eb68816e4a8346b1f8cd711ffd7a4693718cd5ad5b5f70c9f3d9f7e838ccf215828ea108e707d6be963239720f1d70fe2e9faa924bbb40a3a8ceb361914c
+  metadata.gz: 82cb81ab6da6d446736a3e990184bc3c9b1f85c1d6f6bb06f91bcb517a2c1629a6dc5204635dab7a01340987907261fa7df2c02ae5331162679cfe1d7a5ad9c5
+  data.tar.gz: 982f118097a4cae8a784bf9bd1453fef495f5b670fe3d510d1ca6acc7dafb90a8777d5bc20a0771b203833f839323ec388fb72848ea101e76533d3961f66d37e

data/CHANGELOG.md

@@ -1,5 +1,15 @@
-## [Unreleased]
+# Changelog
 
-## [0.1.0] - 2022-09-20
+This project uses [Semantic Versioning 2.0.0](http://semver.org/).
+
+## main
+
+## 0.9.0 - 2023-04-204
+
+ENHANCEMENTS:
+
+- Add `endpoint_url`, `response_headers`, `response_status_code_class` and `retry_count` to `Simplyq::Model::DeliveryAttempt` model [PR #52](https://github.com/simplyqio/apis/pull/52)
+
+## 0.1.0 - 2022-09-20
 
 - Initial release

data/Gemfile

@@ -9,7 +9,7 @@ group :development do
 
   gem "rspec"
 
-  gem "rubocop-rspec"
+  gem "rubocop-rspec", "~> 2.14"
 
   gem "rubocop", "~> 1.36"
 

data/README.md

@@ -1,22 +1,48 @@
-# Simplyq
+# SimplyQ Ruby Client
 
-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/simplyq`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Ruby CI](https://github.com/simplyqio/apis/actions/workflows/ruby-ci.yml/badge.svg?branch=main)](https://github.com/simplyqio/apis/actions/workflows/ruby-ci.yml) [![Gem Version](https://badge.fury.io/rb/simplyq.svg)](https://badge.fury.io/rb/simplyq)
 
-TODO: Delete this and the text above, and describe your gem
+The Ruby client for the [SimplyQ API](https://development.simplyq.io)
+
+[SimplyQ](https://simplyq.io) distributes your events, with the Webhooks API you can send and manage your webhooks reliably and easily.
 
 ## Installation
 
 Install the gem and add to the application's Gemfile by executing:
 
-    $ bundle add simplyq
+    ```shell
+    bundle add simplyq
+    ```
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
-    $ gem install simplyq
+    ```shell
+    gem install simplyq
+    ```
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+# Load the gem
+require 'simplyq'
+
+# Setup the client
+client = Simplyq::Client.new({
+  # Configure Bearer authorization (bmp_2dNkUE1XXXXXXXXXXXXXXXXXXXXXXXXXXXXX): HTTPBearer
+  api_key: ENV.fetch("SIMPLYQ_API_KEY")
+})
+
+app = {
+    uid: 'example-app-1',
+    name: 'Example application #1'
+}
+
+# Create an application
+app = client.applications.create(app)
+```
+
+You can find more examples in the [examples](examples) directory. And also our API reference site which has examples of the ruby client https://developer.simplyq.io.
+
 
 ## Development
 
@@ -26,7 +52,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/simplyq. 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/[USERNAME]/simplyq/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/simplyqio/apis, please first open an issue before opening a PR so we can discuss the changes. 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/simplyqio/apis/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -34,4 +60,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Simplyq project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/simplyq/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the Simplyq project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/simplyqio/apis/blob/main/CODE_OF_CONDUCT.md).

data/lib/simplyq/models/delivery_attempt.rb

@@ -9,19 +9,33 @@ module Simplyq
 
       attr_accessor :endpoint_id
 
+      # The endpoint url of the endpoint when the event delivery was attempted.
+      attr_accessor :endpoint_url
+
       # The response of the endpoint when a delivery attempt was made or null if not yet attempted.
       attr_accessor :response
 
+      # The response headers of the endpoint when the event delivery was attempted.
+      attr_accessor :response_headers
+
       # The response code of the endpoint when the event delivery was attempted.
       attr_accessor :response_status_code
 
+      # The response code class i.e. 2xx, 3xx, 4xx, 5xx of the endpoint when the event delivery was attempted.
+      attr_accessor :response_status_code_class
+
       # The delivery status of the event to the endpoint
       attr_accessor :status
 
       # The tigger of the delivery attempt
       attr_accessor :trigger_type
 
-      # This is the timestamp of when the delivery attempt was made to the endpoint. In case it has not yet been attempted and the status of the delivery attempt is **pending**, then the value of the timestamp will be **null**.
+      # Number of times an event delivery attempt failed before the current attempt.
+      attr_accessor :retry_count
+
+      # This is the timestamp of when the delivery attempt was made to the endpoint.
+      # In case it has not yet been attempted and the status of the delivery attempt
+      # is **pending**, then the value of the timestamp will be **null**.
       attr_accessor :attempted_at
 
       def initialize(attributes = {})
@@ -31,14 +45,24 @@ module Simplyq
 
         self.endpoint_id = attributes[:endpoint_id] if attributes.key?(:endpoint_id)
 
+        self.endpoint_url = attributes[:endpoint_url] if attributes.key?(:endpoint_url)
+
         self.response = attributes[:response] if attributes.key?(:response)
 
+        self.response_headers = attributes[:response_headers] if attributes.key?(:response_headers)
+
         self.response_status_code = attributes[:response_status_code] if attributes.key?(:response_status_code)
 
+        if attributes.key?(:response_status_code_class)
+          self.response_status_code_class = attributes[:response_status_code_class]
+        end
+
         self.status = attributes[:status] if attributes.key?(:status)
 
         self.trigger_type = attributes[:trigger_type] if attributes.key?(:trigger_type)
 
+        self.retry_count = attributes[:retry_count] if attributes.key?(:retry_count)
+
         self.attempted_at = attributes[:attempted_at] if attributes.key?(:attempted_at)
       end
 
@@ -82,10 +106,14 @@ module Simplyq
           id == other.id &&
           event_id == other.event_id &&
           endpoint_id == other.endpoint_id &&
+          endpoint_url == other.endpoint_url &&
           response == other.response &&
+          response_headers == other.response_headers &&
           response_status_code == other.response_status_code &&
+          response_status_code_class == other.response_status_code_class &&
           status == other.status &&
           trigger_type == other.trigger_type &&
+          retry_count == other.retry_count &&
           attempted_at == other.attempted_at
       end
 
@@ -94,10 +122,14 @@ module Simplyq
           id: id,
           event_id: event_id,
           endpoint_id: endpoint_id,
+          endpoint_url: endpoint_url,
           response: response,
+          response_headers: response_headers,
           response_status_code: response_status_code,
+          response_status_code_class: response_status_code_class,
           status: status,
           trigger_type: trigger_type,
+          retry_count: retry_count,
           attempted_at: attempted_at
         }
       end

data/lib/simplyq/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Simplyq
-  VERSION = "0.8.2rc"
+  VERSION = "0.9.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simplyq
 version: !ruby/object:Gem::Version
-  version: 0.8.2rc
+  version: 0.9.0
 platform: ruby
 authors:
 - simplyq-dxtimer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-11-12 00:00:00.000000000 Z
+date: 2023-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -70,7 +70,6 @@ files:
 - ".rubocop_todo.yml"
 - ".tool-versions"
 - CHANGELOG.md
-- CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -109,11 +108,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.4.10
 signing_key: 
 specification_version: 4
 summary: The SimplyQ API client for Ruby

data/CODE_OF_CONDUCT.md

@@ -1,84 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
-
-We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
-
-## Our Standards
-
-Examples of behavior that contributes to a positive environment for our community include:
-
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the overall community
-
-Examples of unacceptable behavior include:
-
-* The use of sexualized language or imagery, and sexual attention or
-  advances of any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email
-  address, without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Enforcement Responsibilities
-
-Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
-
-Community leaders 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, and will communicate reasons for moderation decisions when appropriate.
-
-## Scope
-
-This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at ivan@simplyq.io. All complaints will be reviewed and investigated promptly and fairly.
-
-All community leaders are obligated to respect the privacy and security of the reporter of any incident.
-
-## Enforcement Guidelines
-
-Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
-
-### 1. Correction
-
-**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
-
-**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
-
-### 2. Warning
-
-**Community Impact**: A violation through a single incident or series of actions.
-
-**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
-
-### 3. Temporary Ban
-
-**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
-
-**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
-
-### 4. Permanent Ban
-
-**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
-
-**Consequence**: A permanent ban from any sort of public interaction within the community.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
-available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
-
-Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
-
-[homepage]: https://www.contributor-covenant.org
-
-For answers to common questions about this code of conduct, see the FAQ at
-https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.