clx_rest_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 58035f9ed4775ae2a7ab6734a70a9ac6a4deeba4
+  data.tar.gz: 4706b13a3fc23e92df9078fef2e3a10999599c50
+SHA512:
+  metadata.gz: 12a080d345b2af7046a7cdd5c4c1d97a2677ca397b19aa5bda5f3baa51244e079e1ec056930b4305c327d6e0cafe9a21f89686a13328f07f2ffd63be31808b6e
+  data.tar.gz: 01ee28d8bbb70fd65a73ce0ef39cca67a9970ae659da44d288ddd5a71823b181cf676f39b4c902c32a22edbba2e8b2fdaf71a3badac25df71454655a0be70924

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in clx_rest_api.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,53 @@
+PATH
+  remote: .
+  specs:
+    clx_rest_api (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    coderay (1.1.2)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    hashdiff (0.3.7)
+    method_source (0.9.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    public_suffix (3.0.1)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    safe_yaml (1.0.4)
+    webmock (3.3.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  clx_rest_api!
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  webmock (~> 3.3)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Emric
+
+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,72 @@
+# CLXRestAPI
+Made for creating easy integration with the CLX Rest API.
+You can find their API documentation [here](https://www.clxcommunications.com/docs/sms/http-rest.html).
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'clx_rest_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install clx_rest_api
+
+## Configuration
+To use the API you need a service plan id and a token.
+Use the configuration block to set these.
+
+```ruby
+CLXRestAPI.configure do |config|
+  config.service_plan_id = "my_service_plan_id"
+  config.api_token = "my_api_token"
+end
+```
+
+## Usage
+To use the API create an instance of the `CLXRestAPI::Client` class.
+You can send a request to an endpoint like this:
+```ruby
+client = CLXRestAPI::Client.new
+client.send_batch_message(params: {})
+```
+
+This returns a `CLXRestAPI::Response` instance.
+```ruby
+# Contains the response body parsed from JSON
+response.body
+
+# Contains a Net::HTTP response for further debugging
+response.original_response
+```
+
+## Available endpoints
+As of now these are the available endpoints:
+- :send_batch_messsage, docs: https://www.clxcommunications.com/docs/sms/http-rest.html#send-a-batch-message
+- :retrieve_delivery_report, docs: https://www.clxcommunications.com/docs/sms/http-rest.html#retrieve-a-delivery-report
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rspec` 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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+To define a new endpoint for the client you can use the provided DSL:
+```ruby
+define_endpoint :my_endpoint, :get, "/my_url/:my_param/
+```
+
+`:my_param` will be fetched from the arguments provided when doing the method call.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/standout/clx_rest_api.
+
+## 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,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 "clx_rest_api"
+
+# 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/clx_rest_api.gemspec

@@ -0,0 +1,37 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "clx_rest_api/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "clx_rest_api"
+  spec.version       = CLXRestAPI::VERSION
+  spec.authors       = ["Emric"]
+  spec.email         = ["w.e.w@live.se"]
+
+  spec.summary       = "CLX rest API integration"
+  spec.homepage      = "https://www.github.com/standout/clx-rest-api"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://www.rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 3.3"
+  spec.add_development_dependency "pry"
+end

data/lib/clx_rest_api/base_uri.rb

@@ -0,0 +1,3 @@
+module CLXRestAPI
+  BASE_URI = "https://api.clxcommunications.com"
+end

data/lib/clx_rest_api/client.rb

@@ -0,0 +1,15 @@
+require "clx_rest_api/uri_interpretation"
+require "clx_rest_api/endpoint_dsl"
+
+module CLXRestAPI
+  class Client
+    extend EndpointDSL
+
+    define_endpoint :send_batch_message, :post, "/batches"
+    define_endpoint :retrieve_delivery_report, :get, "/batches/:batch_id/delivery_report"
+
+    def initialize(config = CLXRestAPI.config)
+      @config = config
+    end
+  end
+end

data/lib/clx_rest_api/configuration.rb

@@ -0,0 +1,10 @@
+module CLXRestAPI
+  class Configuration
+    attr_accessor :service_plan_id, :api_token
+
+    def initialize
+      @service_plan_id = nil
+      @api_token = nil
+    end
+  end
+end

data/lib/clx_rest_api/endpoint_dsl.rb

@@ -0,0 +1,15 @@
+require "clx_rest_api/uri_interpretation"
+require "clx_rest_api/request"
+require "ostruct"
+
+module CLXRestAPI
+  module EndpointDSL
+    def define_endpoint(name, method, uri)
+      define_method(name) do |args = {}|
+        uri = URIInterpretation.new(uri, OpenStruct.new(args), config: @config).to_s
+        request = CLXRestAPI::Request.new(uri, method: method, config: @config)
+        request.execute(args[:params])
+      end
+    end
+  end
+end

data/lib/clx_rest_api/request.rb

@@ -0,0 +1,50 @@
+require "clx_rest_api/response"
+require "net/https"
+require "net/http"
+require "json"
+
+module CLXRestAPI
+  class Request
+    attr_reader :uri
+
+    def initialize(uri, method: :get, config: CLXRestAPI.config)
+      @config = config
+      @method = method
+      @uri = URI(uri)
+    end
+
+    def execute(body = {})
+      response = http.request http_request(body)
+      Response.new(response)
+    end
+
+    private
+
+    def http
+      @http ||= Net::HTTP.new(uri.host, uri.port)
+      @http.tap do |protocol|
+        protocol.use_ssl = true
+        protocol.verify_mode = OpenSSL::SSL::VERIFY_PEER
+      end
+    end
+
+    def http_request(body)
+      send "#{@method}_request", body
+    end
+
+    def get_request(body)
+      @uri.query = URI.encode_www_form(body)
+      Net::HTTP::Get.new(@uri).tap do |req|
+        req["Authorization"] = "Bearer #{@config.api_token}"
+      end
+    end
+
+    def post_request(body)
+      Net::HTTP::Post.new(@uri).tap do |req|
+        req["Authorization"] = "Bearer #{@config.api_token}"
+        req.content_type = "application/json"
+        req.body = body.to_json
+      end
+    end
+  end
+end

data/lib/clx_rest_api/response.rb

@@ -0,0 +1,13 @@
+module CLXRestAPI
+  class Response
+    attr_reader :original_response
+
+    def initialize(original_response)
+      @original_response = original_response
+    end
+
+    def body
+      JSON.parse(@original_response.body)
+    end
+  end
+end

data/lib/clx_rest_api/uri_interpretation.rb

@@ -0,0 +1,26 @@
+require "clx_rest_api/base_uri"
+
+module CLXRestAPI
+  class URIInterpretation
+    def initialize(uri, param_receiver, config: CLXRestAPI.config)
+      @service_plan_id = config.service_plan_id
+      @param_receiver = param_receiver
+      @uri = uri
+    end
+
+    def to_s
+      suffix = @uri.gsub(param_regex) {|param| retrieve_param(param) }
+      "#{CLXRestAPI::BASE_URI}/xms/v1/#{@service_plan_id}#{suffix}"
+    end
+
+    private
+
+    def param_regex
+      /(?<=\/):(\w*)/
+    end
+
+    def retrieve_param(param)
+      @param_receiver[param[/\w+/]]
+    end
+  end
+end

data/lib/clx_rest_api/version.rb

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

data/lib/clx_rest_api.rb

@@ -0,0 +1,14 @@
+require "clx_rest_api/configuration"
+require "clx_rest_api/version"
+require "clx_rest_api/client"
+
+module CLXRestAPI
+  class << self
+    attr_accessor :config
+
+    def configure
+      self.config ||= Configuration.new
+      yield(config)
+    end
+  end
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: clx_rest_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Emric
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- w.e.w@live.se
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- clx_rest_api.gemspec
+- lib/clx_rest_api.rb
+- lib/clx_rest_api/base_uri.rb
+- lib/clx_rest_api/client.rb
+- lib/clx_rest_api/configuration.rb
+- lib/clx_rest_api/endpoint_dsl.rb
+- lib/clx_rest_api/request.rb
+- lib/clx_rest_api/response.rb
+- lib/clx_rest_api/uri_interpretation.rb
+- lib/clx_rest_api/version.rb
+homepage: https://www.github.com/standout/clx-rest-api
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://www.rubygems.org
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: CLX rest API integration
+test_files: []