bluehouselab-sms 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a9276bc38cd43b57f03d757fdba8b356ecb0a5ac
+  data.tar.gz: 8a1f8ac32f4fcf7d35770160ace53c9c25e104fb
+SHA512:
+  metadata.gz: 5233cbe38ad03bfe009fc06d653a02dab72a20912a904f4e7fe37c0c2c135663040f46b4471d12e4f7581bb75f5fb19c119660ef92f9f4a8a8a5bc9ab3c25852
+  data.tar.gz: a7f18dfd1e9c580021b6966ce7f2dbc5ba37797904afe936267a282057fe6452a38d492210738c60ffe0459e9e89116c3509046edd163467a8f579f618c4da91

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Cosmic Color
+
+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,53 @@
+# Bluehouselab::Sms
+
+This is a simple client for sending SMS messages to mobile devices via the Bluehouselab API. http://www.bluehouselab.com/
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bluehouselab-sms'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bluehouselab-sms
+
+## Usage
+
+```ruby
+sms = Bluehouselab::Sms.new :api_key => "123", :app_id => "123", :sender => "010111111111"
+
+#send an sms message
+sms.send_message :type => :sms, :receivers => ["0102222222","01033333333"], :content => "Hello World"
+# => { :message_ids => [["0102222222","100001"],["01033333333","100002"]], :success => true, :error => nil, :status_code => 200 }
+
+#send an lms message
+sms.send_message :type => :lms, :receivers => ["0102222222","01033333333"], :content => "Hello World", :subject => "Hello" }
+# => { :message_ids => [["0102222222","100001"],["01033333333","100002"]], :success => true, :error => nil, :status_code => 200 }
+
+#find if the message was delivered successfully
+sms.result "100001"
+# => {:error=>nil, :success=>true, :status_code=>200, :sent_time=>2015-08-28 06:49:05 UTC}
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/CosmicColor/bluehouselab-sms.
+
+
+## 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,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 "bluehouselab/sms"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bluehouselab-sms.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bluehouselab/sms/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bluehouselab-sms"
+  spec.version       = Bluehouselab::VERSION
+  spec.authors       = ["kenleytomlin","neospecial"]
+  spec.email         = ["kenleytomlin@gmail.com"]
+
+  spec.summary       = %q{A simple gem that sends sms messages via the Bluehouselab api}
+  spec.homepage      = "https://github.com/CosmicColor/bluehouselab-sms/"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://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 { |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             "httparty", "~> 0.13.5"
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.3"
+  spec.add_development_dependency "webmock", "~> 1.21.0"
+  spec.add_development_dependency "fuubar", "~> 2.0.0"
+  spec.add_development_dependency "timecop", "~> 0.8.0"
+end

data/lib/bluehouselab/sms.rb

@@ -0,0 +1,116 @@
+require "bluehouselab/sms/version"
+require "httparty"
+require "json"
+
+module Bluehouselab
+  class Sms
+
+    ROUTES = {
+      :lms => "sendlms",
+      :sms => "sendsms",
+      :result => "result"
+    }
+
+    HEADERS = { "Content-Type" => "application/json;charset=utf-8" }
+
+    HTTP_ERRORS = {
+      400 => "Bad request, check the values sent to the server",
+      401 => "Unauthorized, check api key and app_id",
+      402 => "Insufficient credit, please check your account balance",
+      403 => "Forbidden, connect via HTTPS",
+      404 => "Not found, delivery id or resource",
+      406 => "Not acceptable, check the JSON payload isn't malformed",
+      410 => "API deprecated",
+      412 => "Precondition Failed, check the values sent to the server",
+      500 => "Internal server error",
+      503 => "Service unavailable"
+    }
+
+    SEND_RESULT_ERRORS = {
+      -1 => "Cannot confirm at this time, please retry",
+      10000 => "Message failed",
+      10001 => "Device cannot receive messages",
+      10002 => "NPDB error",
+      10003 => "Service temporarily unavailable",
+      10004 => "Receiving device error",
+      10005 => "System error",
+      10006 => "Message request time limit has expired"
+    }
+
+    def initialize(options)
+      raise ArgumentError.new "api_key cannot be nil" unless options[:api_key]
+      raise ArgumentError.new "app_id cannot be nil" unless options[:app_id]
+      raise ArgumentError.new "sender cannot be nil" unless options[:sender]
+      @api_key = options[:api_key]
+      @app_id = options[:app_id]
+      @sender = options[:sender]
+      @base_url = "https://#{@app_id}:#{@api_key}@api.bluehouselab.com/smscenter/v1.0/"
+    end
+
+    def send_message(options)
+      raise ArgumentError.new "send_message options requires a type either :sms or :lms" unless options[:type]
+      raise ArgumentError.new "send_message options requires an array of receiver phone numbers" unless options[:receivers] && options[:receivers].is_a?(Array)
+      raise ArgumentError.new "send_message options requires content" unless options[:content]
+
+      type = options[:type].nil? ? :sms : options[:type]
+
+      raise ArgumentError.new "send_message options[:type] must be one of :sms or :lms" unless type == :sms || type == :lms
+      raise "content too long for type :sms" unless (options[:content].bytesize <= 80 && type == :sms) || ( type == :lms)
+
+      res = send type, options[:receivers], options[:content], options[:subject]
+      parse_send_response res.code, res.parsed_response
+    end
+
+    def result(request_id)
+      res = HTTParty.get "#{@base_url}#{ROUTES[:result]}/#{request_id}", { :headers => HEADERS }
+      parse_result_response res.code, res.parsed_response
+    end
+
+    private
+
+    def parse_error_and_code(code)
+      if code >= 400
+        error = HTTP_ERRORS[code]
+        success = false
+      else
+        error = nil
+        success = true
+      end
+      { :error => error, :success => success, :status_code => code }
+    end
+
+    def parse_result_response(code,parsed_body)
+      error_and_code = parse_error_and_code(code)
+      if error_and_code[:success]
+        if parsed_body['status'] == 0
+          error_and_code.merge! :sent_time => Time.parse(parsed_body['sent_time'])
+        else
+          error = SEND_RESULT_ERRORS[parsed_body['status']]
+          error_and_code.merge!({ :error => error })
+        end
+      else
+        error_and_code
+      end
+    end
+
+    def parse_send_response(code,parsed_body)
+      error_and_code = parse_error_and_code(code)
+      { :message_ids => code >= 400 ? [] : parsed_body["sent"] }.merge! error_and_code
+    end
+
+    def send(type,receivers,content,subject)
+      body = {
+        :sender => @sender,
+        :receivers =>  receivers,
+        :content => content
+      }
+
+      if subject && type == :lms
+        body.merge! :subject => subject
+      end
+
+      HTTParty.post "#{@base_url}#{ROUTES[type]}", :body => body.to_json, :headers => HEADERS
+    end
+
+  end
+end

data/lib/bluehouselab/sms/version.rb

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

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: bluehouselab-sms
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- kenleytomlin
+- neospecial
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-08-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.5
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.21.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.21.0
+- !ruby/object:Gem::Dependency
+  name: fuubar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+description: 
+email:
+- kenleytomlin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bluehouselab-sms.gemspec
+- lib/bluehouselab/sms.rb
+- lib/bluehouselab/sms/version.rb
+homepage: https://github.com/CosmicColor/bluehouselab-sms/
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://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.4.5
+signing_key: 
+specification_version: 4
+summary: A simple gem that sends sms messages via the Bluehouselab api
+test_files: []