toktokkie 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 41c42b1d85b4238c87ffe412a4449728117471095f76f5e0da7587bced060ea2
+  data.tar.gz: 12bb44e3e55d15fff3e312083009c05cb98693f4778e8744af562da163325e84
+SHA512:
+  metadata.gz: 715970dbfc859e4584ecf1a9f9731c247f2894a607a8560e1c0c6fcb09c75475b24c13fa7e405136619030326eeba512591eda505f25e293aed45f01326bbb2e
+  data.tar.gz: 69a6a729ab0af802ed04bfdd949f080164739a477b123dd8ce8aa8c5608243b4a6a919b97bdc49860c9937434c3d5cbfea4fa39846d223e11b4db1d03c47ec93

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,16 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Metrics/BlockLength
+  Enabled: false
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.0.1] - 2023-01-18
+
+- Initial experimental release

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,63 @@
+PATH
+  remote: .
+  specs:
+    toktokkie (0.0.1)
+      faraday (~> 2.7.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.5.0)
+    faraday (2.7.3)
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (3.0.2)
+    json (2.6.3)
+    parallel (1.22.1)
+    parser (3.2.0.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.1)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.43.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.24.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.24.1)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  arm64-darwin-22
+
+DEPENDENCIES
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  toktokkie!
+
+BUNDLED WITH
+   2.4.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Christopher Spring
+
+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,55 @@
+# Toktokkie
+
+## Installation
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add toktokkie_rb
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install toktokkie_rb
+
+## Configuration
+```ruby
+Toktokkie.configure do |config|
+  config.key = "[YOUR_API_KEY]"
+  config.secret = "[YOUR_API_SECRET]"
+end
+```
+
+## Usage
+```ruby
+client = Toktokkie.client
+client.create_event(
+  # required
+  payload: {
+    title: "New commenct",
+    body: "Charles commented on your blog post!",
+    action: {
+      "text": "View comment",
+      "url": "https://www.example.com/blog/1/comments#comment-2"
+    }
+  },
+  # required
+  recipients_payload: [
+    { external_id: "users-12345" }
+  ],
+  # optional
+  tags: ["Inbox A", "Inbox B"]
+)
+```
+
+
+## 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/toktokkie.
+
+## 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,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/toktokkie/client.rb

@@ -0,0 +1,37 @@
+module Toktokkie
+  class Client
+    REQUEST_DEFAULTS = {
+      timeout: 10 # seconds
+    }
+
+    def initialize(key:, secret:, url:)
+      @key = key
+      @secret = secret
+      @url = url
+    end
+
+    def create_event(payload: {}, tags: [], recipients_payload: [])
+      response = connection.post("api/v1/events") do |request|
+        request.body = {
+          payload:,
+          tags:,
+          recipients_payload:
+        }.to_json
+      end
+    end
+
+    protected
+
+    def connection
+      @connection ||= Faraday.new(
+        url: @url,
+        request: REQUEST_DEFAULTS,
+        headers: {
+          "Content-Type" => "application/json",
+          "X-TOKTOK-KEY" => @key,
+          "X-TOKTOK-SECRET" => @secret,
+        },
+      )
+    end
+  end
+end

data/lib/toktokkie/configuration.rb

@@ -0,0 +1,24 @@
+module Toktokkie
+  class Configuration
+    DEFAULT_URL = "https://www.toktokkie.io"
+
+    attr_accessor :key, :secret, :url
+
+    def initialize
+      self.url = DEFAULT_URL if blank?(url)
+    end
+
+    def usable?
+      %i[key secret url].none? do |setting|
+        puts "setting #{setting} #{send(setting)}"
+        blank?(send(setting))
+      end
+    end
+
+    private
+
+    def blank?(var)
+      var.to_s.strip.length.zero?
+    end
+  end
+end

data/lib/toktokkie/version.rb

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

data/lib/toktokkie.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require "faraday"
+
+require_relative "toktokkie/version"
+require_relative "toktokkie/configuration"
+require_relative "toktokkie/client"
+
+module Toktokkie
+  ConfigurationError = Class.new(StandardError)
+
+  class << self
+    def configuration
+      @configuration ||= Toktokkie::Configuration.new
+    end
+
+    def reset_configuration
+      @configuration = nil
+    end
+
+    def client
+      @client ||= begin
+        raise ConfigurationError, "Missing configuration information" unless configuration.usable?
+        Toktokkie::Client.new(
+          key: configuration.key,
+          secret: configuration.secret,
+          url: configuration.url
+        )
+      end
+    end
+
+    def configure
+      yield configuration
+    end
+  end
+end

data/sig/toktokkie.rbs

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

data/toktokkie.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "lib/toktokkie/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "toktokkie"
+  spec.version = Toktokkie::VERSION
+  spec.authors = ["Christopher Spring"]
+  spec.email = ["chris@toktokkie.com"]
+
+  spec.summary = "Toktokkie ruby api client"
+  spec.description = "Interact with the Toktokkie api to create events and notifications"
+  spec.homepage = "https://github.com/TokTokkieOrg/toktokkie_rb"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/TokTokkieOrg/toktokkie_rb"
+  spec.metadata["changelog_uri"] = "https://github.com/TokTokkieOrg/toktokkie_rb/blob/main/CHANGELOG.md"
+
+  # 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|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 "faraday", "~> 2.7.3"
+
+  # 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,74 @@
+--- !ruby/object:Gem::Specification
+name: toktokkie
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Christopher Spring
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-01-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.3
+description: Interact with the Toktokkie api to create events and notifications
+email:
+- chris@toktokkie.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/toktokkie.rb
+- lib/toktokkie/client.rb
+- lib/toktokkie/configuration.rb
+- lib/toktokkie/version.rb
+- sig/toktokkie.rbs
+- toktokkie.gemspec
+homepage: https://github.com/TokTokkieOrg/toktokkie_rb
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/TokTokkieOrg/toktokkie_rb
+  source_code_uri: https://github.com/TokTokkieOrg/toktokkie_rb
+  changelog_uri: https://github.com/TokTokkieOrg/toktokkie_rb/blob/main/CHANGELOG.md
+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.4.1
+signing_key:
+specification_version: 4
+summary: Toktokkie ruby api client
+test_files: []