engagespark_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 75bdb976f67e5fd0cebc4ec79abcded8177ca65e78b569d64293b670881beaad
+  data.tar.gz: 1be77429cb1176aca6fcccca3ab8aea9de7c84a94834ae20125a42f5bcff2920
+SHA512:
+  metadata.gz: 6e79a9ea1acb1c43a41aa5e1054a9d86e9b9b0d81a00381c70d79de0264206b83b5ddb9dafc6f1691ff722b434039de7e119ad9cac9d5d90f12d7ed9abbddc77
+  data.tar.gz: d4c722a54fd227af2a0e90ef1a1d22c378fc8e1c81d5c2d9325c8a0c48234e10a4589412686f24a0694588ae14f12281fa295188638b30c240e0c4d7fce186da

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+/spec/config.yml

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.0.2

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+# 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]
+- Initial version. Only phonenumber API supported

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 ramon.tayag@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,8 @@
+source "https://rubygems.org"
+
+ruby "2.6.3"
+
+# Specify your gem's dependencies in engagespark_client.gemspec
+gemspec
+
+gem "pry-byebug"

data/Gemfile.lock

@@ -0,0 +1,104 @@
+PATH
+  remote: .
+  specs:
+    engagespark_client (0.1.0)
+      activesupport (>= 5.0)
+      api_client_base (~> 1.0)
+      typhoeus (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.0.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    api_client_base (1.5.0)
+      activesupport (>= 3.0)
+      gem_config (>= 0.3.1)
+      virtus (>= 1.0)
+    axiom-types (0.1.1)
+      descendants_tracker (~> 0.0.4)
+      ice_nine (~> 0.11.0)
+      thread_safe (~> 0.3, >= 0.3.1)
+    byebug (11.0.1)
+    coderay (1.1.2)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
+    concurrent-ruby (1.1.5)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.3)
+    equalizer (0.0.11)
+    ethon (0.12.0)
+      ffi (>= 1.3.0)
+    ffi (1.12.1)
+    gem_config (0.3.2)
+    hashdiff (1.0.0)
+    i18n (1.8.2)
+      concurrent-ruby (~> 1.0)
+    ice_nine (0.11.2)
+    method_source (0.9.2)
+    minitest (5.14.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.7.0)
+      byebug (~> 11.0)
+      pry (~> 0.10)
+    public_suffix (4.0.3)
+    rake (10.5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    safe_yaml (1.0.5)
+    thread_safe (0.3.6)
+    typhoeus (1.3.1)
+      ethon (>= 0.9.0)
+    tzinfo (1.2.6)
+      thread_safe (~> 0.1)
+    vcr (5.0.0)
+    virtus (1.0.5)
+      axiom-types (~> 0.1)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0, >= 0.0.3)
+      equalizer (~> 0.0, >= 0.0.9)
+    webmock (3.8.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    zeitwerk (2.2.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  engagespark_client!
+  pry-byebug
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  vcr (~> 5.0)
+  webmock (~> 3.8)
+
+RUBY VERSION
+   ruby 2.6.3p62
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Ramon Tayag
+
+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,60 @@
+# EngagesparkClient
+
+Ruby wrapper for the engageSPARK API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'engagespark_client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install engagespark_client
+
+## Usage
+
+```
+client = EngagesparkClient.new(token: "YOUR-TOKEN", org_id: 321)
+client.send_sms(
+  to: "639181234567",
+  message: "Hello, world!",
+)
+
+response.error # an error message in the response, if any
+response.message_id # "SMS20200124T085255-123-4567"
+response.estimate_parts # 1
+response.estimate_micro # 20000
+response.estimate # "0.02"
+response.delivery_deadline # "2020-01-25T08:52:55.75319741Z"
+response.contact_id # 0
+response.to # "639181234567"
+response.message # "Hello, world!"
+```
+
+See `spec/acceptance` for usage.
+
+## Development
+
+- `cp spec/config{.sample,}.yml`
+- Edit `spec/config.yml` with your own settings
+- Make changes
+- `rspec spec`
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/bloom-solutions/engagespark_client-ruby. 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 EngagesparkClient project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/bloom-solutions/engagespark_client-ruby/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

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

@@ -0,0 +1,39 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "engagespark_client/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "engagespark_client"
+  spec.version       = EngagesparkClient::VERSION
+  spec.authors       = ["Ramon Tayag"]
+  spec.email         = ["ramon.tayag@gmail.com"]
+
+  spec.summary       = %q{Ruby wrapper for the engageSPARK API.}
+  spec.homepage      = "https://github.com/bloom-solutions/engagespark_client-ruby"
+  spec.license       = "MIT"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/bloom-solutions/engagespark_client-ruby"
+  spec.metadata["changelog_uri"] = "https://github.com/bloom-solutions/engagespark_client-ruby/blob/master/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(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", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "vcr", "~> 5.0"
+  spec.add_development_dependency "webmock", "~> 3.8"
+
+  spec.add_runtime_dependency "api_client_base", "~> 1.0"
+  spec.add_runtime_dependency "activesupport", ">= 5.0"
+  spec.add_runtime_dependency "typhoeus", "~> 1.0"
+end

data/lib/engagespark_client.rb

@@ -0,0 +1,23 @@
+require "engagespark_client/version"
+require "api_client_base"
+require "active_support/core_ext/string/inflections"
+require "active_support/core_ext/hash/indifferent_access"
+require "pathname"
+
+module EngagesparkClient
+  class Error < StandardError; end
+
+  include APIClientBase::Base.module
+
+  with_configuration do
+    has :host, classes: String, default: "https://api.engagespark.com"
+    has :token, classes: String
+    has :org_id, classes: Integer
+  end
+end
+
+require "engagespark_client/client"
+lib_dir = Pathname.new(File.dirname(__FILE__))
+Dir[lib_dir.join("engagespark_client", "**", "*.rb")].each do |file|
+  require file
+end

data/lib/engagespark_client/client.rb

@@ -0,0 +1,14 @@
+module EngagesparkClient
+  class Client
+
+    include APIClientBase::Client.module(default_opts: :default_opts)
+    api_action :send_sms
+
+    private
+
+    def default_opts
+      { host: host, token: token, org_id: org_id }
+    end
+
+  end
+end

data/lib/engagespark_client/requests/send_sms_request.rb

@@ -0,0 +1,31 @@
+module EngagesparkClient
+  class SendSmsRequest
+
+    include APIClientBase::Request.module(action: :post)
+    attribute :token, String
+    attribute :org_id, Integer
+    attribute :to, String
+    attribute :from, String
+    attribute :message, String
+
+    private
+
+    def headers
+      {
+        "Content-Type" => "application/json",
+        "Authorization" => "Token #{token}"
+      }
+    end
+
+    def path
+      "/v1/sms/phonenumber"
+    end
+
+    def body
+      %i[org_id to from message].each_with_object({}) do |attr, hash|
+        hash[attr.to_s.camelize(:lower)] = send(attr)
+      end.to_json
+    end
+
+  end
+end

data/lib/engagespark_client/responses/send_sms_response.rb

@@ -0,0 +1,20 @@
+module EngagesparkClient
+  class SendSmsResponse
+
+    include APIClientBase::Response.module
+
+    attribute :error, String, lazy: true, default: :default_error
+    attribute :message_id, String, lazy: true, default: :default_message_id
+    attribute(:estimate_parts, Integer, {
+      lazy: true,
+      default: :default_estimate_parts,
+    })
+    attribute :estimate_micro, Integer, lazy: true, default: :default_estimate_micro
+    attribute :estimate, Decimal, lazy: true, default: :default_estimate
+    attribute :delivery_deadline, DateTime, lazy: true, default: :default_delivery_deadline
+    attribute :contact_id, Integer, lazy: true, default: :default_contact_id
+    attribute :to, String, lazy: true, default: :default_to
+    attribute :message, String, lazy: true, default: :default_message
+    
+  end
+end

data/lib/engagespark_client/version.rb

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

metadata

@@ -0,0 +1,177 @@
+--- !ruby/object:Gem::Specification
+name: engagespark_client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ramon Tayag
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-01-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: api_client_base
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: 
+email:
+- ramon.tayag@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- engagespark_client.gemspec
+- lib/engagespark_client.rb
+- lib/engagespark_client/client.rb
+- lib/engagespark_client/requests/send_sms_request.rb
+- lib/engagespark_client/responses/send_sms_response.rb
+- lib/engagespark_client/version.rb
+homepage: https://github.com/bloom-solutions/engagespark_client-ruby
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/bloom-solutions/engagespark_client-ruby
+  source_code_uri: https://github.com/bloom-solutions/engagespark_client-ruby
+  changelog_uri: https://github.com/bloom-solutions/engagespark_client-ruby/blob/master/CHANGELOG.md
+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.6
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for the engageSPARK API.
+test_files: []