playsms 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e54d6f2f4d0527ac6cb56f7641b489a73471b5a2
+  data.tar.gz: b589235ed725c8c7c83e75bcd13571c0a76c3279
+SHA512:
+  metadata.gz: 0f3980d62cde72e54c9f687ef509337968fc6531cde0d9c61594799686901ef773e7a88438922af0373773f3f7abaf6a54c6ad141fc6ce1bbcbf747e8b7789ac
+  data.tar.gz: 03386ecf6aa33fee2bf49f2cde1fa4dbc362a66325e1a31100dee94ef826cf942dd8aa0cabbaceed10a265b97732d899c12bba4bd76605a42be75f135a970718

data/LICENSE.txt

@@ -0,0 +1,18 @@
+Copyright (c) 2016 Matt Mencel
+
+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,81 @@
+Playsms Client Library for Ruby
+=============================
+
+Borrowed heavily from Nexmo Ruby Library: https://github.com/Nexmo/nexmo-ruby
+
+[![Gem Version](https://badge.fury.io/rb/playsms.svg)](https://badge.fury.io/rb/playsms) [![Build Status](https://api.travis-ci.org/Playsms/playsms-ruby.svg?branch=master)](https://travis-ci.org/Playsms/playsms-ruby)
+
+This is the Ruby client library for PlaySMS's API. To use it you'll
+need a PlaySMS system setup.
+
+* [Installation](#installation)
+* [Usage](#usage)
+* [SMS API](#sms-api)
+* [Coverage](#api-coverage)
+* [License](#license)
+
+Installation
+------------
+
+To install the Ruby client library using Rubygems:
+
+    gem install playsms
+
+Alternatively you can clone the repository:
+
+    git clone git@github.com:WIU/playsms-ruby.git
+
+
+Usage
+-----
+
+Begin by requiring the playsms library:
+
+```ruby
+require 'playsms'
+```
+
+Then construct a client object with your user and secret:
+
+```ruby
+client = Playsms::Client.new(user: 'YOUR-API-USER', secret: 'YOUR-API-SECRET')
+```
+
+For production you can specify the `PLAYSMS_USER` and `PLAYSMS_SECRET`
+environment variables instead of specifying the key and secret explicitly.
+
+## SMS API
+
+### Send a text message
+
+```ruby
+response = client.send_message(to: 'YOUR NUMBER', msg: 'Hello world')
+
+unless response['data'].nil? || response['data'][0]['status'] != 'OK'
+  puts "Sent message #{response['data'][0]['smslog_id']}"
+else
+  puts "Error: #{response['error_string']}"
+end
+```
+
+Docs: [https://github.com/antonraharja/playSMS/blob/master/documents/development/WEBSERVICES.md](https://github.com/antonraharja/playSMS/blob/master/documents/development/WEBSERVICES.md)
+
+API Coverage
+------------
+
+* Messaging
+    * [X] Send
+    * [ ] Delivery Receipt
+    * [ ] Inbound Messages
+    * [ ] Search
+        * [ ] Message
+        * [ ] Messages
+        * [ ] Rejections
+
+
+License
+-------
+
+This library is released under the [MIT License][license]
+
+[license]: LICENSE.txt

data/lib/playsms.rb

@@ -0,0 +1,86 @@
+require 'playsms/version'
+require 'playsms/params'
+require 'playsms/errors/error'
+require 'playsms/errors/client_error'
+require 'playsms/errors/server_error'
+require 'playsms/errors/authentication_error'
+require 'net/http'
+require 'json'
+
+module Playsms
+  class Client
+    attr_accessor :user, :secret
+
+    def initialize(options = {})
+      @user = options.fetch(:user) { ENV.fetch('PLAYSMS_USER') }
+      @secret = options.fetch(:secret) { ENV.fetch('PLAYSMS_SECRET') }
+      @host = options.fetch(:host) { 'http://playsms.example.com' }
+      @user_agent = "playsms-ruby/#{VERSION} ruby/#{RUBY_VERSION}"
+    end
+
+    def send_message(params)
+      post(@host, '/index.php?app=ws&op=pv&', params)
+    end
+
+    private
+
+    def get(host, request_uri, params = {})
+      uri = URI(host + request_uri + Params.encode(params.merge(u: @user, h: @secret)))
+
+      message = Net::HTTP::Get.new(uri.request_uri)
+
+      request(uri, message)
+    end
+
+    def post(host, request_uri, params)
+      uri = URI(host + request_uri + Params.encode(params.merge(u: @user, h: @secret)))
+
+      message = Net::HTTP::Post.new(uri.request_uri)
+
+      request(uri, message)
+    end
+
+    def put(host, request_uri, params)
+      uri = URI(host + request_uri + Params.encode(params.merge(u: @user, h: @secret)))
+
+      message = Net::HTTP::Put.new(uri.request_uri)
+
+      request(uri, message)
+    end
+
+    def delete(host, request_uri)
+      uri = URI(host + request_uri + Params.encode(params.merge(u: @user, h: @secret)))
+
+      message = Net::HTTP::Delete.new(uri.request_uri)
+
+      request(uri, message)
+    end
+
+    def request(uri, message)
+      http = Net::HTTP.new(uri.host, Net::HTTP.http_default_port)
+
+      message['User-Agent'] = @user_agent
+
+      http_response = http.request(message)
+
+      case http_response
+      when Net::HTTPNoContent
+        :no_content
+      when Net::HTTPSuccess
+        if http_response['Content-Type'].split(';').first == 'application/json'
+          JSON.parse(http_response.body)
+        else
+          http_response.body
+        end
+      when Net::HTTPUnauthorized
+        fail AuthenticationError, "#{http_response.code} response from #{uri.host}"
+      when Net::HTTPClientError
+        fail ClientError, "#{http_response.code} response from #{uri.host}"
+      when Net::HTTPServerError
+        fail ServerError, "#{http_response.code} response from #{uri.host}"
+      else
+        fail Error, "#{http_response.code} response from #{uri.host}"
+      end
+    end
+  end
+end

data/lib/playsms/errors/authentication_error.rb

@@ -0,0 +1,4 @@
+module Playsms
+  class AuthenticationError < ClientError
+  end
+end

data/lib/playsms/errors/client_error.rb

@@ -0,0 +1,4 @@
+module Playsms
+  class ClientError < Error
+  end
+end

data/lib/playsms/errors/error.rb

@@ -0,0 +1,4 @@
+module Playsms
+  class Error < StandardError
+  end
+end

data/lib/playsms/errors/server_error.rb

@@ -0,0 +1,4 @@
+module Playsms
+  class ServerError < Error
+  end
+end

data/lib/playsms/params.rb

@@ -0,0 +1,13 @@
+require 'cgi'
+
+module Playsms
+  module Params
+    def self.encode(params)
+      params.flat_map { |k, vs| Array(vs).map { |v| "#{escape(k)}=#{escape(v)}" } }.join('&')
+    end
+
+    def self.escape(component)
+      CGI.escape(component.to_s)
+    end
+  end
+end

data/lib/playsms/version.rb

@@ -0,0 +1,3 @@
+module Playsms
+  VERSION = '0.0.1'
+end

data/playsms.gemspec

@@ -0,0 +1,28 @@
+require File.expand_path('lib/playsms/version', File.dirname(__FILE__))
+
+Gem::Specification.new do |s|
+  s.name        = 'playsms'
+  s.version     = Playsms::VERSION
+  s.license     = 'MIT'
+  s.platform = Gem::Platform::RUBY
+  s.date        = '2016-12-13'
+  s.summary     = 'This is the Ruby client library for PlaySMS\'s API.'
+  s.description = 'PlaySMS Client Library for Ruby'
+  s.files = Dir.glob('{lib,spec}/**/*') + %w(LICENSE.txt README.md playsms.gemspec)
+  s.authors     = ['Matt Mencel']
+  s.email       = 'mr-mencel@wiu.edu'
+  s.homepage    = 'https://github.com/WIU/playsms-ruby'
+  s.required_ruby_version = '>= 1.9.3'
+  s.add_development_dependency('rake', '~> 11.0')
+  s.add_development_dependency('minitest', '~> 5.0')
+  s.add_development_dependency "rspec"
+
+  if RUBY_VERSION == '1.9.3'
+    s.add_development_dependency('addressable', '< 2.5.0')
+    s.add_development_dependency('webmock', '~> 1.0')
+  else
+    s.add_development_dependency('webmock', '~> 2.0')
+  end
+
+  s.require_path = 'lib'
+end

data/spec/playsms_spec.rb

@@ -0,0 +1,100 @@
+require 'spec_helper'
+
+describe 'Playsms::Client' do
+  before do
+    @user = 'user_xxx'
+    @secret = 'secret_xxx'
+    @base_url = 'http://playsms.example.com'
+    @response_body = { body: '{"key":"value"}', headers: { 'Content-Type' => 'application/json;charset=utf-8' } }
+    @response_object = { 'key' => 'value' }
+    @client = Playsms::Client.new(key: @user, secret: @secret)
+  end
+
+  # describe 'send_message method' do
+  #   it 'posts to the sms resource and returns the response object' do
+  #     expect_post "#{@base_url}/index.php?app=ws&op=pv&u=#{@user}&h=#{@secret}&to=number&msg=Hey!"
+  #
+  #     @client.send_message(to: 'number', msg: 'Hey!').must_equal(@response_object)
+  #   end
+  # end
+  #
+  # it 'raises an authentication error exception if the response code is 401' do
+  #   stub_request(:get, /#{@base_url}/).to_return(status: 401)
+  #
+  #   proc { @client.send_message(to: 'number', msg: 'Hey!') }.must_raise(Playsms::AuthenticationError)
+  # end
+  #
+  # it 'raises a client error exception if the response code is 4xx' do
+  #   stub_request(:get, /#{@base_url}/).to_return(status: 400)
+  #
+  #   proc { @client.send_message(to: 'number', msg: 'Hey!') }.must_raise(Playsms::ClientError)
+  # end
+  #
+  # it 'raises a server error exception if the response code is 5xx' do
+  #   stub_request(:get, /#{@base_url}/).to_return(status: 500)
+  #
+  #   proc { @client.send_message(to: 'number', msg: 'Hey!') }.must_raise(Playsms::ServerError)
+  # end
+  #
+  # it 'includes a user-agent header with the library version number and ruby version number' do
+  #   headers = { 'User-Agent' => "playsms-ruby/#{Playsms::VERSION} ruby/#{RUBY_VERSION}" }
+  #
+  #   stub_request(:get, /#{@base_url}/).with(headers: headers).to_return(@response_body)
+  #
+  #   @client.send_message(to: 'number', msg: 'Hey!')
+  # end
+  #
+  # it 'provides an option for specifying a different hostname to connect to' do
+  #   expect_get "http://playsms-sandbox.example.com/index.php?app=ws&op=pv&u=#{@user}&h=#{@secret}&to=number&msg=Hey!"
+  #
+  #   @client = Playsms::Client.new(key: @user, secret: @secret, host: 'playsms-sandbox.example.com')
+  #
+  #   @client.send_message(to: 'number', msg: 'Hey!')
+  # end
+  #
+  # private
+  #
+  # def expect(method_symbol, url, body = nil)
+  #   headers = { 'Authorization' => /\ABearer (.+)\.(.+)\.(.+)\z/ }
+  #
+  #   @request = stub_request(method_symbol, url)
+  #
+  #   if method_symbol == :delete
+  #     @request.with(headers: headers).to_return(status: 204)
+  #   elsif body.nil?
+  #     @request.with(headers: headers).to_return(@response_body)
+  #   else
+  #     headers['Content-Type'] = 'application/json'
+  #
+  #     @request.with(headers: headers, body: body).to_return(@response_body)
+  #   end
+  # end
+  #
+  # def expect_get(url)
+  #   @request = stub_request(:get, url).to_return(@response_body)
+  # end
+  #
+  # def expect_post(url)
+  #   # body = WebMock::Util::QueryMapper.query_to_values(data)
+  #
+  #   #headers = { 'Content-Type' => 'application/x-www-form-urlencoded' }
+  #
+  #   @request = stub_request(:post, url).to_return(@response_body)
+  # end
+  #
+  # def expect_put(url, data)
+  #   body = WebMock::Util::QueryMapper.query_to_values(data)
+  #
+  #   headers = { 'Content-Type' => 'application/x-www-form-urlencoded' }
+  #
+  #   @request = stub_request(:put, url).with(body: body, headers: headers).to_return(@response_body)
+  # end
+  #
+  # def expect_delete(url)
+  #   @request = stub_request(:delete, url).to_return(status: 204)
+  # end
+  #
+  # after do
+  #   assert_requested(@request) if defined?(@request)
+  # end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'minitest/autorun'
+require 'webmock/minitest'
+require 'webmock/rspec'
+require 'playsms'
+
+RSpec.configure do |config|
+  # some (optional) config here
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: playsms
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Matt Mencel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: rspec
+  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: webmock
+  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'
+description: PlaySMS Client Library for Ruby
+email: mr-mencel@wiu.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/playsms.rb
+- lib/playsms/errors/authentication_error.rb
+- lib/playsms/errors/client_error.rb
+- lib/playsms/errors/error.rb
+- lib/playsms/errors/server_error.rb
+- lib/playsms/params.rb
+- lib/playsms/version.rb
+- playsms.gemspec
+- spec/playsms_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/WIU/playsms-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.7
+signing_key: 
+specification_version: 4
+summary: This is the Ruby client library for PlaySMS's API.
+test_files: []