clickatell-catcher-rack 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b7d83eb0da1bfa1e2b86a1b2b5b6d30ee885180e
+  data.tar.gz: a69ce1ef3b9864ba29841f4b16b5e828379893b3
+SHA512:
+  metadata.gz: 0426d725d9453cae03fb2982b4f2853ae0aac8f8d279a7f725d6638df3be0a60962b40aef8e0d1f1cbd2686ae94a85f20e91016e73ec22ccddc79bc68e23c037
+  data.tar.gz: 591acd4e895c453b08638533e8be58ac7fa8ab5c1a387d6bafe6638c69d4f5c85b90e982ec6faf3e9f24e88df47be049185058f54e3613d3b914885b5813abf8

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,11 @@
+.bundle/
+.yardoc
+Gemfile.lock
+_yardoc/
+coverage/
+doc/
+pkg/
+spec/reports/
+tmp/
+vendor/bundle
+clickatell_catcher.yml

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,5 @@
+Metrics/LineLength:
+  Max: 105
+
+Documentation:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.0.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in clickatell-catcher-rack.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Grant Petersen-Speelman
+
+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,63 @@
+# Clickatell::Catcher::Rack
+
+[![Build Status](https://travis-ci.org/grantspeelman/clickatell-catcher-rack.svg?branch=master)](https://travis-ci.org/grantspeelman/clickatell-catcher-rack)
+
+Simple Lightweight rack app the allows for a local sandbox clickatell enviroment.
+This Rack app emulates some of the [Clickatells api](https://www.clickatell.com/help/apidocs/)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+group :development do
+    gem 'clickatell-catcher-rack'
+end
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install clickatell-catcher-rack
+
+## Usage
+
+using in rails add a initializers file with the following:
+
+```ruby
+  if Rails.env.development?
+      require 'clickatell/catcher/rack'
+      Rails.application.configure do
+        config.middleware.use Clickatell::Catcher::Rack::Middleware, logger: Rails.logger
+      end
+  end
+```
+or for other rack apps add the following to your config.ru
+
+```ruby
+  require 'clickatell/catcher/rack'
+  use Clickatell::Catcher::Rack::Middleware
+```
+
+Now in development mode you can point you clickatell sms code at `http://localhost:3000/rest/message` and
+visit `http://localhost:3000/rest/message` to see the messages.
+Suggested a config to be able to switch between `https://api.clickatell.com/rest/message` and `http://localhost:3000/rest/message`
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec 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 tags, 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/grantspeelman/clickatell-catcher-rack.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler/setup'
+
+require 'bundler/gem_tasks'
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: %w(rubocop spec build)

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'clickatell/catcher/rack'
+
+# 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

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install --path vendor/bundle
+
+# Do any other automated setup that you need to do here

data/clickatell-sandbox-rack.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'clickatell/catcher/rack/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'clickatell-catcher-rack'
+  spec.version       = Clickatell::Catcher::Rack::VERSION
+  spec.authors       = ['Grant Petersen-Speelman']
+  spec.email         = ['grantspeelman@gmail.com']
+
+  spec.summary       = 'local sms catcher clickatell environment.'
+  spec.description   = 'Simple rack app the allows for a local catcher clickatell environment.'
+  spec.homepage      = 'https://github.com/grantspeelman/clickatell-catcher-rack'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'rack'
+  spec.add_dependency 'multi_json', '~> 1.0'
+
+  spec.add_development_dependency 'rack-test'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('lib/clickatell/catcher/rack', __dir__)
+run Clickatell::Catcher::Rack::Middleware

data/lib/clickatell/catcher/rack.rb

@@ -0,0 +1,56 @@
+require 'rack/request'
+require 'rack/nulllogger'
+
+require 'clickatell/catcher/rack/version'
+require 'clickatell/catcher/rack/message_adder'
+require 'clickatell/catcher/rack/messages_renderer'
+require 'clickatell/catcher/rack/shared_array'
+
+module Clickatell
+  module Catcher
+    module Rack
+      class Middleware
+        attr_reader :messages
+
+        def initialize(app, options = {})
+          @app = app
+          @messages = Clickatell::Catcher::Rack::SharedArray.new
+          @logger = options[:logger] || ::Rack::NullLogger.new(nil)
+          @message_adder = MessageAdder.new(@messages)
+          @messages_renderer = MessagesRenderer.new(@messages)
+        end
+
+        def add_message(request_body)
+          @message_adder.add(request_body)
+          @logger.debug("[#{Process.pid}] Messages: " + @messages.inspect)
+          @message_adder.rack_response
+        end
+
+        def render_messages
+          @logger.debug("[#{Process.pid}] Rendering Messages: " + @messages.inspect)
+          @messages_renderer.rack_response
+        end
+
+        def rest_message(request)
+          if request.get?
+            render_messages
+          else
+            add_message(request.body.read)
+          end
+        end
+
+        def call(env)
+          request = ::Rack::Request.new(env)
+          if request.path == '/rest/message'
+            rest_message(request)
+          else
+            status, headers, body = @app.call(env)
+
+            # return result
+            [status, headers, body]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/clickatell/catcher/rack/message_adder.rb

@@ -0,0 +1,35 @@
+require 'multi_json'
+
+module Clickatell
+  module Catcher
+    module Rack
+      class MessageAdder
+        def initialize(messages)
+          @messages = messages
+          @message_id = 1
+        end
+
+        def add(request_body)
+          message = MultiJson.load(request_body)
+          @messages << message.merge('added_at' => Time.now)
+          response = { 'data' => { 'message' => build_messages_response(message) } }
+          @json_body = MultiJson.dump(response)
+        end
+
+        def rack_response
+          [200, { 'Content-Type' => 'application/json' }, [@json_body]]
+        end
+
+        private
+
+        def build_messages_response(message)
+          start_index = @message_id
+          @message_id += message['to'].size
+          message['to'].map.with_index(start_index) do |to, i|
+            { 'accepted' => true, 'to' => to, 'apiMessageId' => i.to_s }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/clickatell/catcher/rack/messages.html.erb

@@ -0,0 +1,81 @@
+<html>
+<head>
+  <link rel="stylesheet" href="http://yui.yahooapis.com/pure/0.6.0/pure-min.css">
+  <!--[if lte IE 8]>
+  <link rel="stylesheet" href="http://yui.yahooapis.com/pure/0.6.0/grids-responsive-old-ie-min.css">
+  <![endif]-->
+  <!--[if gt IE 8]><!-->
+  <link rel="stylesheet" href="http://yui.yahooapis.com/pure/0.6.0/grids-responsive-min.css">
+  <!--<![endif]-->
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+
+  <style>
+    .custom-menu-wrapper {
+      background-color: #808080;
+      margin-bottom: 2.5em;
+      white-space: nowrap;
+      position: relative;
+    }
+
+    .custom-menu {
+      display: inline-block;
+      width: auto;
+      vertical-align: middle;
+      -webkit-font-smoothing: antialiased;
+    }
+
+    .custom-menu .pure-menu-heading {
+      color: white;
+    }
+
+    .custom-menu .pure-menu-heading:hover {
+      background-color: transparent;
+    }
+
+    .custom-menu-top {
+      position: relative;
+      padding-top: .5em;
+      padding-bottom: .5em;
+    }
+
+    .custom-menu-brand {
+      display: block;
+      text-align: center;
+      position: relative;
+    }
+  </style>
+</head>
+<body>
+
+<div class="custom-menu-wrapper">
+  <div class="pure-menu custom-menu custom-menu-top">
+    <span class="pure-menu-heading custom-menu-brand">Clickatell sms catcher</span>
+  </div>
+</div>
+
+<div class="content pure-g">
+  <div class="pure-u-1-24"></div>
+  <div class="pure-u-23-24">
+    <table class="pure-table pure-table-horizontal">
+      <thead>
+      <tr>
+        <th>Time</th>
+        <th>To</th>
+        <th>Text</th>
+      </tr>
+      </thead>
+
+      <tbody>
+      <% @messages.each do |message| %>
+          <tr>
+            <td><%= message['added_at'] %></td>
+            <td><%= message['to'].join(',') %></td>
+            <td><%= message['text'] %></td>
+          </tr>
+      <% end %>
+      </tbody>
+    </table>
+  </div>
+</div>
+</body>
+</html>

data/lib/clickatell/catcher/rack/messages_renderer.rb

@@ -0,0 +1,27 @@
+require 'multi_json'
+require 'erb'
+
+module Clickatell
+  module Catcher
+    module Rack
+      class MessagesRenderer
+        def initialize(messages)
+          @messages = messages
+          @renderer = ERB.new(File.read(__dir__ + '/messages.html.erb'))
+        end
+
+        def rack_response
+          [200,
+           { 'Content-Type' => 'text/html' },
+           [render_content]]
+        end
+
+        private
+
+        def render_content
+          @renderer.result(binding)
+        end
+      end
+    end
+  end
+end

data/lib/clickatell/catcher/rack/shared_array.rb

@@ -0,0 +1,54 @@
+require 'yaml/store'
+
+module Clickatell
+  module Catcher
+    module Rack
+      class SharedArray
+        include Enumerable
+
+        def initialize
+          @store = YAML::Store.new(store_patch)
+          @store.transaction do |store|
+            store[:data] ||= []
+          end
+        end
+
+        private
+
+        def store_patch
+          if File.directory?('tmp')
+            'tmp/clickatell_catcher.yml'
+          else
+            'clickatell_catcher.yml'
+          end
+        end
+
+        public
+
+        def clear
+          @store.transaction do |store|
+            store[:data] = []
+          end
+        end
+
+        def <<(item)
+          @store.transaction do |store|
+            store[:data].unshift(item)
+            store[:data].pop if store[:data].size > 25
+          end
+        end
+
+        def each
+          data = @store.transaction { @store[:data] }
+          data.each do |item|
+            yield(item)
+          end
+        end
+
+        def size
+          @store.transaction { @store[:data] }.size
+        end
+      end
+    end
+  end
+end

data/lib/clickatell/catcher/rack/version.rb

@@ -0,0 +1,7 @@
+module Clickatell
+  module Catcher
+    module Rack
+      VERSION = '0.1.0'.freeze
+    end
+  end
+end

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: clickatell-catcher-rack
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Grant Petersen-Speelman
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  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: rack-test
+  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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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'
+description: Simple rack app the allows for a local catcher clickatell environment.
+email:
+- grantspeelman@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .coveralls.yml
+- .gitignore
+- .rspec
+- .rubocop.yml
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- clickatell-sandbox-rack.gemspec
+- config.ru
+- lib/clickatell/catcher/rack.rb
+- lib/clickatell/catcher/rack/message_adder.rb
+- lib/clickatell/catcher/rack/messages.html.erb
+- lib/clickatell/catcher/rack/messages_renderer.rb
+- lib/clickatell/catcher/rack/shared_array.rb
+- lib/clickatell/catcher/rack/version.rb
+homepage: https://github.com/grantspeelman/clickatell-catcher-rack
+licenses:
+- MIT
+metadata: {}
+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.0.14
+signing_key: 
+specification_version: 4
+summary: local sms catcher clickatell environment.
+test_files: []