brasilfone_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 41578249c76b016bda6604ba940bd67b558a2d03
+  data.tar.gz: 39f1cf13406692058a9f91cee1dff5c17f1f4703
+SHA512:
+  metadata.gz: 51c7dc953fa3ce45fca14b456a8d20c628707dbe3ee872f308a6b7036aef4a4daf4068921948996ed42db3639c3ac33727f530930a0cf1e707bfb0d1a83f321c
+  data.tar.gz: e0c4cdf4fe1b6e9016fb757cd78ab284694804cebfa1ff7d7844ee64e5122f89f256e5ea4a40afa310f6b57dccea5ed92aea32735d0edbad6ae8d1a806752ab4

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/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Victor Fonseca
+
+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,55 @@
+# BrasilfoneAPI
+
+This gem provides a simple ruby API to communicate with Brasilfone's web API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'brasilfone_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install brasilfone_api
+
+
+## Configuring
+
+Add your authorized credentials to BrasilfoneAPI:
+
+```ruby
+BrasilfoneAPI.configure do |config|
+  config.username = 'martianbuddy'
+  config.password = '0508'
+end
+```
+
+Remember that you need to enable the credentials from Brasilfone's dashboard
+
+## Usage
+
+Those are the methods that can be called from the module:
+
+```ruby
+BrasilfoneAPI.send_sms('phone_number', 'message text')
+BrasilfoneAPI.sms_status('sms_id')
+BrasilfoneAPI.balance
+BrasilfoneAPI.sms_status_by_date_range('start date', 'end date') #yyyy-mm-dd hh:mm:ss
+BrasilfoneAPI.reply_status_for_sms('sms_id')
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/redealumni/brasilfone_api.
+
+
+## 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 "brasilfone_api"
+
+# 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/brasilfone_api.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'brasilfone_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "brasilfone_api"
+  spec.version       = BrasilfoneAPI::VERSION
+  spec.authors       = ["Victor Fonseca"]
+  spec.email         = ["victorcel19@gmail.com"]
+
+  spec.summary       = %q{Used to interface with Brasilfone's web API}
+  spec.description   = %q{Used to interface with Brasilfone's web API}
+  spec.homepage      = "https://github.com/redealumni/brasilfone_api"
+  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 "xmlhasher", "~> 1.0.2"
+
+  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 "pry", "~> 0.10.3"
+  spec.add_development_dependency "webmock", "~> 1.24.1"
+end

data/lib/brasilfone_api/configuration.rb

@@ -0,0 +1,21 @@
+module BrasilfoneAPI
+  class Configuration
+    attr_accessor :username, :password
+
+    def self.configure
+      @config ||= Configuration.new
+      yield(@config) if block_given?
+      @config
+    end
+
+    def self.config
+      @config || configure
+    end
+
+    def self.reset
+      @config || configure
+      config.username = nil
+      config.password = nil
+    end
+  end
+end

data/lib/brasilfone_api/http_api_handler/service_uri.rb

@@ -0,0 +1,65 @@
+module BrasilfoneAPI
+  module HttpAPIHandler
+    module ServiceURI
+      require 'uri'
+
+      class << self
+        def uri_for_service(service, parameters)
+          builder = URIBuilder.new(service, parameters)
+          builder.build
+        end
+      end
+
+      class URIBuilder
+        require 'brasilfone_api/http_api_handler/uri_constants'
+
+        def initialize(service, parameters)
+          @service = service
+          @parameters = parameters
+        end
+
+        def build
+          service_exists = URIConstants::SERVICES_NAMES.key?(@service)
+          raise 'Invalid Service' unless service_exists
+          @parameters.each do |param, _value|
+            param_exists = URIConstants::PARAMETERS_NAMES.key?(param)
+            raise 'Invalid Paramenters' unless param_exists
+          end
+
+          uri = URI(URIConstants::BRASILFONE_BASE_URI)
+          uri.query = uri_parameters
+          uri
+        end
+
+        private
+
+        def uri_parameters
+          parameters = {}
+          parameters.merge!(service_parameter)
+          parameters.merge!(credential_parameters)
+          parameters.merge!(other_parameters)
+          URI.encode_www_form(parameters)
+        end
+
+        def service_parameter
+          { service: URIConstants::SERVICES_NAMES[@service] }
+        end
+
+        def credential_parameters
+          username = BrasilfoneAPI.config.username
+          password = BrasilfoneAPI.config.password
+          { username: username, password: password }
+        end
+
+        def other_parameters
+          other_params = {}
+          @parameters.each do |param, value|
+            param_name = URIConstants::PARAMETERS_NAMES[param]
+            other_params[param_name] = value
+          end
+          other_params
+        end
+      end
+    end
+  end
+end

data/lib/brasilfone_api/http_api_handler/uri_constants.rb

@@ -0,0 +1,23 @@
+module BrasilfoneAPI
+  module HttpAPIHandler
+    module URIConstants
+      BRASILFONE_BASE_URI = 'http://api.brasilfone.com.br/'.freeze
+
+      SERVICES_NAMES = {
+        SEND_SMS: 'SendSMS'.freeze,
+        GET_SMS_STATUS: 'GetStatus'.freeze,
+        GET_BALANCE: 'GetBalance'.freeze,
+        GET_STATUS_BY_DATE: 'GetStatusByDate'.freeze,
+        GET_REPLY_STATUS: 'GetStatusResposta'.freeze
+      }.freeze
+
+      PARAMETERS_NAMES = {
+        destination: 'to'.freeze,
+        id: 'id'.freeze,
+        start_date: 'date_start'.freeze,
+        end_date: 'date_end'.freeze,
+        text: 'text'.freeze
+      }.freeze
+    end
+  end
+end

data/lib/brasilfone_api/http_api_handler.rb

@@ -0,0 +1,24 @@
+require 'net/http'
+require 'net/http'
+require 'brasilfone_api/http_api_handler/service_uri'
+require 'uri'
+require 'xmlhasher'
+
+module BrasilfoneAPI
+  module HttpAPIHandler
+    class << self
+      def send_request_for_service(service, parameters = {})
+        uri = BrasilfoneAPI::HttpAPIHandler::ServiceURI.uri_for_service(
+          service,
+          parameters
+        )
+
+        request = Net::HTTP::Get.new(uri)
+        response = Net::HTTP.start(uri.host, uri.port) do |http|
+          http.request(request)
+        end
+        XmlHasher.parse(response.body)
+      end
+    end
+  end
+end

data/lib/brasilfone_api/version.rb

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

data/lib/brasilfone_api.rb

@@ -0,0 +1,49 @@
+require 'brasilfone_api/version'
+require 'brasilfone_api/configuration'
+require 'brasilfone_api/http_api_handler'
+
+module BrasilfoneAPI
+  class << self
+    def configure(&block)
+      BrasilfoneAPI::Configuration.configure(&block)
+    end
+
+    def config
+      BrasilfoneAPI::Configuration.config
+    end
+
+    def send_sms(destination, text)
+      HttpAPIHandler.send_request_for_service(
+        :SEND_SMS,
+        destination: destination,
+        text: text
+      )
+    end
+
+    def sms_status(sms_id)
+      HttpAPIHandler.send_request_for_service(
+        :GET_SMS_STATUS,
+        id: sms_id
+      )
+    end
+
+    def balance
+      HttpAPIHandler.send_request_for_service(:GET_BALANCE)
+    end
+
+    def sms_status_by_date_range(start_date, end_date)
+      HttpAPIHandler.send_request_for_service(
+        :GET_STATUS_BY_DATE,
+        start_date: start_date,
+        end_date: end_date
+      )
+    end
+
+    def reply_status_for_sms(sms_id)
+      HttpAPIHandler.send_request_for_service(
+        :GET_SMS_STATUS,
+        id: sms_id
+      )
+    end
+  end
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: brasilfone_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Victor Fonseca
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: xmlhasher
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+- !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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.24.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.24.1
+description: Used to interface with Brasilfone's web API
+email:
+- victorcel19@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- brasilfone_api.gemspec
+- lib/brasilfone_api.rb
+- lib/brasilfone_api/configuration.rb
+- lib/brasilfone_api/http_api_handler.rb
+- lib/brasilfone_api/http_api_handler/service_uri.rb
+- lib/brasilfone_api/http_api_handler/uri_constants.rb
+- lib/brasilfone_api/version.rb
+homepage: https://github.com/redealumni/brasilfone_api
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Used to interface with Brasilfone's web API
+test_files: []