logsnag 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d88dde87b1c7aca08cfacee42830b74e5557f4650b369636f189ea407bc3f003
+  data.tar.gz: ddac8e808eb01f115a30da170b9dc43ade986ff2c94ea2019afdfc4d0a312a1c
+SHA512:
+  metadata.gz: 6b72b52ac3b8c6f6b0ee5ccfea80d97225068d91ec987849d73386c97d3963cea662c7c179c0670db03fe2a86ae9c7e9919220871bea4e5db834ac881e892efa
+  data.tar.gz: 958c8d9ceb350f4c581f093f44235de5d7d708d28e27110a7bc049c2ab81e6e36225582c1e676de8fa170db7e607f0b9fc1f1d1157fac054cb9081161b59df56

data/.env.example

@@ -0,0 +1 @@
+TOKEN=

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,27 @@
+PATH
+  remote: .
+  specs:
+    logsnag (0.1.0)
+      faraday (~> 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    dotenv (2.7.6)
+    faraday (2.2.0)
+      faraday-net_http (~> 2.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (2.0.2)
+    rake (13.0.6)
+    ruby2_keywords (0.0.5)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  dotenv
+  logsnag!
+  rake (~> 13.0)
+
+BUNDLED WITH
+   2.3.5

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Dean Perry
+
+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,41 @@
+# LogSnag
+
+Ruby Library for sending LogSnag events.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "logsnag"
+```
+
+## Usage
+
+### Set Token
+
+Firstly you'll need to set an API Token.
+
+```ruby
+@logsnag = LogSnag::Client.new(token: "")
+```
+
+### Sending an Event
+
+```ruby
+@logsnag.log(project: "my-project", channel: "channel", event: "my-event")
+```
+
+Available Options:
+
+- description
+- icon - Single emoji for the event icon
+- notify - if this event should send a notification
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/deanpcmad/logsnag.
+
+## 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,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/lib/log_snag/client.rb

@@ -0,0 +1,57 @@
+module LogSnag
+  class Client
+    BASE_URL = "https://api.logsnag.com/v1"
+
+    attr_reader :token, :adapter
+
+    def initialize(token:, adapter: Faraday.default_adapter, stubs: nil)
+      @token = token
+      @adapter = adapter
+
+      # Test stubs for requests
+      @stubs = stubs
+    end
+
+    def log(project:, channel:, event:, **params)
+      attributes = {project: project, channel: channel, event: event}
+      Log.new post_request("log", body: attributes.merge(params)).body
+    end
+
+    def connection
+      @connection ||= Faraday.new(BASE_URL) do |conn|
+        conn.request :authorization, :basic, token
+        conn.request :json
+        conn.response :json
+        conn.adapter adapter, @stubs
+      end
+    end
+
+    private
+
+    def post_request(url, body:, headers: {})
+      handle_response connection.post(url, body, headers)
+    end
+
+    def handle_response(response)
+      case response.status
+      when 400
+        raise Error, "Error 400: Your request was malformed. '#{response.body["message"]}'"
+      when 401
+        raise Error, "Error 401: You did not supply valid authentication credentials. '#{response.body["errors"]}'"
+      when 403
+        raise Error, "Error 403: You are not allowed to perform that action."
+      when 404
+        raise Error, "Error 404: No results were found for your request."
+      when 409
+        raise Error, "Error 409: Your request was a conflict."
+      when 429
+        raise Error, "Error 429: Your request exceeded the API rate limit."
+      when 500
+        raise Error, "Error 500: We were unable to perform the request due to server-side problems."
+      end
+
+      response
+    end
+
+  end
+end

data/lib/log_snag/log.rb

@@ -0,0 +1,11 @@
+require "ostruct"
+
+module LogSnag
+  class Log < OpenStruct
+
+    def initialize(attributes)
+      super OpenStruct.new(attributes)
+    end
+
+  end
+end

data/lib/log_snag/version.rb

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

data/lib/log_snag.rb

@@ -0,0 +1,11 @@
+require "faraday"
+require "json"
+require_relative "log_snag/version"
+
+module LogSnag
+  class Error < StandardError; end
+
+  autoload :Client, "log_snag/client"
+  autoload :Log,    "log_snag/log"
+
+end

data/lib/logsnag.rb

@@ -0,0 +1 @@
+require "log_snag"

data/logsnag.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "lib/log_snag/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "logsnag"
+  spec.version = LogSnag::VERSION
+  spec.authors = ["Dean Perry"]
+  spec.email = ["dean@deanpcmad.com"]
+
+  spec.summary = "Ruby Library for sending LogSnag events"
+  spec.description = spec.summary
+  spec.homepage = "https://deanpcmad.com"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/deanpcmad/logsnag"
+
+  # 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(__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"]
+
+  spec.add_dependency "faraday", "~> 2.0"
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: logsnag
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dean Perry
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-04-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Ruby Library for sending LogSnag events
+email:
+- dean@deanpcmad.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.example"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/log_snag.rb
+- lib/log_snag/client.rb
+- lib/log_snag/log.rb
+- lib/log_snag/version.rb
+- lib/logsnag.rb
+- logsnag.gemspec
+homepage: https://deanpcmad.com
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://deanpcmad.com
+  source_code_uri: https://github.com/deanpcmad/logsnag
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key: 
+specification_version: 4
+summary: Ruby Library for sending LogSnag events
+test_files: []