easy-sms 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d6a555985287091ddf1af312e45dccd6a25ffedc
+  data.tar.gz: f22c228e114a89a1fc9caf2e7e1a5a01b70b7838
+SHA512:
+  metadata.gz: 555fd5d9c0e3b707dfd9c8169fe4c26601c45387da1680592efd82f790d892ffc5017684470cdd1016536c42fafc21e9cf6ff8fd719d01e995e213cf5a0f3bc6
+  data.tar.gz: f318ac47eb847159ddf3b53cb8eebad8e047f892b1923a0a9955e287b2e72f310de4d3cabf0bc112a3dfc7efa7af1f97460b1ea47a37db0fa2408a97605fd309

data/.gitignore

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

data/.rspec

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

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at paveltyk@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 PavelT
+
+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,105 @@
+# Easy::Sms
+
+The Easy SMS gem is a wrapper for Easy SMS API.
+
+## Using with Ruby/Rails
+
+First of all you will need to install the easy-sms gem. And add it to a Gemfile if needed.
+
+```
+$ gem install easy-sms
+```
+
+### Sending SMS
+
+You can send SMS right away with the `ENV['EASYSMS_URL']` and 'easy-sms' gem installed in your app. No additional configuration required.
+
+Use `EasySMS::Client#messages.create(options)` to send SMS. Options:
+
+* `to` - required. Recipient phone number in [E.164](http://en.wikipedia.org/wiki/E.164) format. Example: '+12067450316'
+* `from` - optional. Sender phone number in [E.164](http://en.wikipedia.org/wiki/E.164) format. Example: '+12067450316'
+* `body` - required. The text body of the message. Up to 1600 characters long.
+
+```ruby
+require 'easy-sms'
+
+# By default initializer will use the EASYSMS_URL config variable to configure the client instance.
+client = EasySMS::Client.new
+puts client.messages.create to: '+12067450316', body: 'Hello from Easy SMS.' #=> {"body"=>"Hello from Easy SMS.", "c_at"=>2016-01-25 13:58:38 UTC, "from"=>nil, "status"=>"pending", "to"=>"+12067450316", "uid"=>"56a62a0ebbf109000c000000"}
+# The received SMS can be seen at: http://sms-receive.net/12067450316-USA (free web service to receive SMS online)
+```
+
+Note the status of SMS is 'pending', which mean the SMS is not delivered yet. It will take a few seconds to process the SMS. You may receive HTTP POST requests to the status callback URL once SMS delivery status change. To do so, please specify the `sms_status_url` for your account. [Read more](#configuring-easy-sms-account)
+
+### Creating and releasing phone numbers
+
+Use `EasySMS::Client#phone_numbers.create(options)` to create a phone number. Options:
+
+* `country_code` - optional. Two-letter country code of the phone number. Default 'US'
+* `pattern` - optional. The pattern of the phone number. Default is nil. Example: '*******654'
+* `inbound_sms_url` - optional. The callback URL to be triggered when your phone number receives SMS. Example: 'http://api.example.com/sms/callback'
+
+```ruby
+require 'easy-sms'
+
+client = EasySMS::Client.new
+phone_number = client.phone_numbers.create #=> {"inbound_sms_url"=>nil, "phone_number"=>"+12183011654", "primary"=>true, "uid"=>"56a630d53017290006000000", "country_code"=>"US"}
+puts "Purchased phone number #{phone_number['phone_number']}"
+client.phone_numbers.delete(phone_number['uid'])
+puts "Released phone number #{phone_number['phone_number']}"
+```
+
+The `EasySMS::Client#phone_numbers.delete(uid)` method is used to release a phone number. This method accepts one argument - phone number UID *(the one returned by EasySMS::Client#phone_numbers.create)*.
+
+### Receiving SMS
+
+Any inbound SMS to one of your phone numbers will trigger a HTTP POST request to your callback URL. You may set the callback url on the phone number instance via the `EasySMS::Client#phone_numbers.update` method, or pass the `inbound_sms_url` option to `EasySMS::Client#phone_numbers.create` when you create a phone number.
+
+`EasySMS::Client#phone_numbers.update(uid, options)` accepts phone number UID and options:
+
+* `inbound_sms_url` - optional. The callback URL to be triggered when your phone number receives SMS. Example: 'http://api.example.com/sms/callback'
+
+```ruby
+require 'easy-sms'
+
+client = EasySMS::Client.new
+phone_numbers = client.phone_numbers.list
+uid = phone_numbers.list.first['uid']
+client.phone_numbers.update(uid, inbound_sms_url: 'http://api.example.com/sms/callback') #=> {message_uid: '56a21298778404d264000000', to: '+12183011654', from: '+12183011699', body: 'Hello there!', direction: 'inbound', c_at: '2016-01-22 14:53:04 UTC'}
+```
+
+The POST request to your callback URL will include these parameters:
+
+* `message_uid` - UID of the message. A 24 characters string.
+* `to` - recipient phone number (one of your phone numbers) in [E.164](http://en.wikipedia.org/wiki/E.164) format. Example: '+12067450316'
+* `from` - sender phone number in [E.164](http://en.wikipedia.org/wiki/E.164) format. Example: '+12067450399'
+* `body` - text body of SMS.
+* `direction` - 'inbound'.
+* `c_at` - time when SMS was received. Example: '2016-01-22 14:53:04 UTC'
+
+### Configuring Easy SMS Account
+
+You may want to fine tune your account. To check current account state run `EasySMS::client.account.get`. The result is a hash with valuable information for current account status and configuration.
+
+Use `EasySMS::client.account.update(options)` to update your account configuration. Options:
+
+* `sms_status_url` - optional. The callback URL to be triggered when SMS status change. Example: ‘http://api.example.com/sms-status/callback’
+
+```ruby
+client = EasySMS::Client.new
+client.account.get #=> {"plan"=>"gold", "sms_status_url"=>nil, "uid"=>"56a21186778404d266000001"}
+client.account.update(sms_status_url: 'http://api.example.com/sms-status/callback') #=> {"plan"=>"gold", "sms_status_url"=>"http://api.example.com/sms-status/callback", "uid"=>"56a21186778404d266000001"}
+```
+
+## Local Setup
+
+After provisioning the add-on it’s necessary to locally replicate the config vars so your development environment can operate against the service.
+
+Use the **Foreman** gem for example to run a commands within environment loaded from `.env` file. Add the `EASYSMS_URL` variable to your `.env` file.
+
+```
+EASYSMS_URL=https://<account_id>:<token>@api.easysmsapp.com/accounts/<account_id>
+```
+
+Though less portable it’s also possible to run a script using `export EASYSMS_URL=https://<account_id>:<token>@api.easysmsapp.com/accounts/<account_id> ruby script.rb`.
+

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 "easy_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,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/easy-sms.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'easy_sms/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "easy-sms"
+  spec.version       = EasySMS::VERSION
+  spec.platform      = Gem::Platform::RUBY
+  spec.authors       = ["PavelT"]
+  spec.email         = ["paveltyk@gmail.com"]
+
+
+  spec.summary       = %q{Easy SMS API wrapper}
+  spec.description   = %q{Send SMS globally with Easy SMS gem. Ruby API wrapper}
+  spec.homepage      = "https://github.com/PavelTyk/easy-sms"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 1.22"
+
+  spec.add_dependency 'rest-client', '~> 1.8'
+  spec.add_dependency 'json', '~> 1.8'
+end

data/lib/easy-sms.rb

@@ -0,0 +1 @@
+require 'easy_sms'

data/lib/easy_sms.rb

@@ -0,0 +1,12 @@
+require 'time'
+require 'json'
+require 'rest-client'
+
+require "easy_sms/version"
+require "easy_sms/client"
+require "easy_sms/account_resource"
+require "easy_sms/message_resource"
+require "easy_sms/phone_number_resource"
+
+module EasySMS
+end

data/lib/easy_sms/account_resource.rb

@@ -0,0 +1,17 @@
+module EasySMS
+  class AccountResource < Struct.new(:client)
+    def get
+      res = client.get('', {})
+
+      JSON.parse(res).tap do |json|
+        json['c_at'] = Time.parse(json['c_at']) if json['c_at']
+      end
+    end
+
+    def update(attrs = {})
+      res = client.put('', attrs)
+
+      JSON.parse(res)
+    end
+  end
+end

data/lib/easy_sms/client.rb

@@ -0,0 +1,61 @@
+module EasySMS
+  class Client
+    attr_reader :uri
+
+    def initialize(url = nil)
+      @url = url || ENV['EASYSMS_URL'] || ENV['EASY_SMS_URL']
+      raise 'Resource URL not set. Please pass a valid URL to initializer, or set EASYSMS_URL environment variable.' unless @url
+      @resource = RestClient::Resource.new(@url)
+      @uri = URI.parse(@url)
+    end
+
+    def messages
+      MessageResource.new(self)
+    end
+
+    def phone_numbers
+      PhoneNumberResource.new(self)
+    end
+
+    def account
+      AccountResource.new(self)
+    end
+
+    def get(path, attrs)
+      begin
+        #TODO: add attrs to url or let it be handled by RestClient
+        @resource[path].get(content_type: :json, accept: :json)
+      rescue RestClient::Exception => e
+        json = JSON.parse(e.response) rescue nil
+        raise Error.new([e, json].compact.join(' '))
+      end
+    end
+
+    def post(path, attrs)
+      begin
+        @resource[path].post(attrs.to_json, content_type: :json, accept: :json)
+      rescue RestClient::Exception => e
+        json = JSON.parse(e.response) rescue nil
+        raise Error.new([e, json].compact.join(' '))
+      end
+    end
+
+    def put(path, attrs)
+      begin
+        @resource[path].put(attrs.to_json, content_type: :json, accept: :json)
+      rescue RestClient::Exception => e
+        json = JSON.parse(e.response) rescue nil
+        raise Error.new([e, json].compact.join(' '))
+      end
+    end
+
+    def delete(path)
+      begin
+        @resource[path].delete(content_type: :json, accept: :json)
+      rescue RestClient::Exception => e
+        json = JSON.parse(e.response) rescue nil
+        raise Error.new([e, json].compact.join(' '))
+      end
+    end
+  end
+end

data/lib/easy_sms/message_resource.rb

@@ -0,0 +1,11 @@
+module EasySMS
+  class MessageResource < Struct.new(:client)
+    def create(attrs = {})
+      res = client.post('/messages', attrs)
+
+      JSON.parse(res).tap do |json|
+        json['c_at'] = Time.parse(json['c_at']) if json['c_at']
+      end
+    end
+  end
+end

data/lib/easy_sms/phone_number_resource.rb

@@ -0,0 +1,27 @@
+module EasySMS
+  class PhoneNumberResource < Struct.new(:client)
+    def list(attrs = {})
+      res = client.get('/phone_numbers', attrs)
+
+      JSON.parse(res)
+    end
+
+    def create(attrs = {})
+      res = client.post('/phone_numbers', attrs)
+
+      JSON.parse(res)
+    end
+
+    def update(uid, attrs = {})
+      res = client.put("/phone_numbers/#{uid}", attrs)
+
+      JSON.parse(res)
+    end
+
+    def delete(uid)
+      res = client.delete("/phone_numbers/#{uid}")
+
+      JSON.parse(res)
+    end
+  end
+end

data/lib/easy_sms/version.rb

@@ -0,0 +1,3 @@
+module EasySMS
+  VERSION = '0.9.0'
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: easy-sms
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- PavelT
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-28 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.22'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+description: Send SMS globally with Easy SMS gem. Ruby API wrapper
+email:
+- paveltyk@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- easy-sms.gemspec
+- lib/easy-sms.rb
+- lib/easy_sms.rb
+- lib/easy_sms/account_resource.rb
+- lib/easy_sms/client.rb
+- lib/easy_sms/message_resource.rb
+- lib/easy_sms/phone_number_resource.rb
+- lib/easy_sms/version.rb
+homepage: https://github.com/PavelTyk/easy-sms
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Easy SMS API wrapper
+test_files: []