sms50X-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 28e1805fcfe6dfb3e8188ead669bf138a911c0dc
+  data.tar.gz: a784f5a4d8e3658ad589a855781de63909abd47a
+SHA512:
+  metadata.gz: c2648fe81fca079d658b56dc5ac8f63b6ec1d044c37c3b6dcdea8f0bb2e924a7fb16bb54185e82318961bb0ee32c6515e04f0a875559774f427805e0c8b3e67b
+  data.tar.gz: abab0c6c9897db8fc15c219ab241aee11a58afc73df5a79be0d7594c38f9cf43034823bd375b9405d3fe835c9da15073eff0324c043fdff166cc24e1508bca29

data/.coveralls.yml

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

data/.gitignore

@@ -0,0 +1,36 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.travis.yml

@@ -0,0 +1,16 @@
+language: ruby
+cache: bundler
+
+rvm:
+  - 2.3.0
+
+script: 'bundle exec rake'
+
+notifications:
+  email:
+    recipients:
+      - pablo.cordero@ejedigitalcr.com
+    on_failure: change
+    on_success: never
+
+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 pablocordero@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 sms50X.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Pablo Cordero
+
+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,65 @@
+# Sms50X
+
+[![Build Status](https://travis-ci.org/ejedigitalcr/sms50X-ruby.svg?branch=master)](https://travis-ci.org/ejedigitalcr/sms50X-ruby)
+
+[![Coverage Status](https://coveralls.io/repos/github/ejedigitalcr/sms50X-ruby/badge.svg?branch=master)](https://coveralls.io/github/ejedigitalcr/sms50X-ruby?branch=master)
+
+A Ruby library for interacting with the SMS50X Web API (<http://www.sms506.com>).
+
+## Installation
+
+Add this line to your Gemfile:
+
+```ruby
+gem 'sms50X'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sms50X
+
+## Usage
+
+### Send a single SMS message
+
+```ruby
+require 'sms50X'
+client = SMS50X::Client.new('API_KEY')
+message = client.messages.build( to: '55515523', content: 'This is a test message.')
+response = message.deliver
+
+if response.success
+  puts response.message_id
+else
+  puts response.error_code
+  puts response.error_description
+end
+```
+
+### Check balance
+
+```ruby
+require 'sms50X'
+client = SMS50X::Client.new('API_KEY')
+balance = client.balance
+puts balance # => 25
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/[USERNAME]/sms50X. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sms50X"
+
+# 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/coveralls

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'coveralls' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("coveralls", "coveralls")

data/bin/rake

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/safe_yaml

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'safe_yaml' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("safe_yaml", "safe_yaml")

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/lib/generators/sms50X_generator.rb

@@ -0,0 +1,6 @@
+class Sms50XGenerator < Rails::Generators::Base
+  source_root File.expand_path("../templates", __FILE__)
+  def create_initializer_file
+    copy_file "sms50X.rb", "config/initializers/sms50X.rb"
+  end
+end

data/lib/generators/templates/sms50X.rb

@@ -0,0 +1,6 @@
+require 'sms50X'
+
+Sms50X.configure do |config|
+  config.api_key = nil
+  config.country_code = nil
+end

data/lib/sms50X.rb

@@ -0,0 +1,25 @@
+require "sms50X/version"
+require "sms50X/configuration"
+require "sms50X/client"
+require "faraday"
+
+module Sms50X
+  extend Configuration
+
+  def self.balance
+    response = Faraday.get("#{API_URL}/balance/#{API_KEY}")
+    response.body.to_i
+  end
+
+  def self.deliver(phone_number, message)
+    response = Faraday.get("#{API_URL}/sms/#{API_KEY}", { t: phone_number, m: message } )
+    response.body.to_i
+  end
+
+  def self.messages_sent(month)
+    response = Faraday.get("#{API_URL}/stat/#{API_KEY}/#{month}")
+    response.body.to_i
+  end
+
+
+end

data/lib/sms50X/client.rb

@@ -0,0 +1,53 @@
+module Sms50X
+
+  class Client
+
+    attr_accessor :api_key, :country_code, :host
+
+    def initialize(*args)
+      options = args.last.is_a?(Hash) ? args.pop : {}
+
+      @api_key = get_api_key(args[0])
+      @country_code = get_country_code(args[1])
+
+      if [@api_key, @country_code].any? { |k| k.nil? }
+        raise ArgumentError, 'API key and country code are required'
+      end
+
+      @host = get_host
+
+    end
+
+    def balance
+      response = Faraday.get("#{host}/balance/#{api_key}")
+      response.body.to_i
+    end
+
+    private
+
+      def get_api_key(arg)
+        [arg, Sms50X.api_key, ENV['SMS50X_API_KEY']].find{ |x| x }
+      end
+
+      def get_country_code(arg)
+        [arg, Sms50X.country_code, ENV['SMS50X_COUNTRY_CODE']].find{ |x| x }
+      end
+
+      def get_host
+        # ISO 3166-1 alpha-3 codes
+        countries = {
+          'GTM' => '502', # Guatemala
+          'SLV' => '503', # El Salvador
+          'HND' => '504', # Honduras
+          'CRI' => '506', # Costa Rica
+          'PAN' => '507'  # Panama
+        }
+
+        code = countries.fetch(country_code) { countries['CRI'] }
+
+        "http://api.sms#{code}.com"
+      end
+
+  end
+
+end

data/lib/sms50X/configuration.rb

@@ -0,0 +1,28 @@
+module Sms50X
+  module Configuration
+
+    DEFAULTS = {
+      api_key: nil,
+      country_code: 'CRI'
+    }
+
+    DEFAULTS.each_key do |attribute|
+      attr_accessor attribute
+    end
+
+    # Make sure we have the default values set when we get 'extended'
+    def self.extended(base)
+      base.reset
+    end
+
+    def reset
+      self.api_key = DEFAULTS[:api_key]
+      self.country_code = DEFAULTS[:country_code]
+    end
+
+    def configure
+      yield self
+    end
+
+  end
+end

data/lib/sms50X/version.rb

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

data/sms50X.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sms50X/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sms50X-ruby"
+  spec.version       = Sms50X::VERSION
+  spec.authors       = ["Pablo Cordero"]
+  spec.email         = ["pablo.cordero@ejedigitalcr.com"]
+
+  spec.summary       = %q{Ruby wrapper for the SMS50X.com [http://www.sms506.com] API.}
+  spec.description   = %q{Send SMSs.}
+  spec.homepage      = "https://github.com/ejedigitalcr/sms50X-ruby"
+  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_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "faraday"
+end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: sms50X-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pablo Cordero
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-11 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: 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: vcr
+  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: '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: faraday
+  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: Send SMSs.
+email:
+- pablo.cordero@ejedigitalcr.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/coveralls
+- bin/rake
+- bin/safe_yaml
+- bin/setup
+- lib/generators/sms50X_generator.rb
+- lib/generators/templates/sms50X.rb
+- lib/sms50X.rb
+- lib/sms50X/client.rb
+- lib/sms50X/configuration.rb
+- lib/sms50X/version.rb
+- sms50X.gemspec
+homepage: https://github.com/ejedigitalcr/sms50X-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: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.1
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for the SMS50X.com [http://www.sms506.com] API.
+test_files: []