locasms 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8f33aa42b1dc5d11101c5ffa1a2e7bc33a1237d6
-  data.tar.gz: b99d06a8c076000c42981c084cf99ed3859ffa44
+  metadata.gz: 12853fa646f333fceb3ced3a9fa7c357bb51495d
+  data.tar.gz: 65f14f3bd5ec19d1a7a2b6da9d1cac23c72296d0
 SHA512:
-  metadata.gz: 7ce62a3e053a3a9c73a9c4cf0181192a41ee93fc194397759e06f6dc95c1f93a2e83ba7815c39b9194443eee3a66fddeb34cd1a2d9d1182457e1e0f6d899044a
-  data.tar.gz: 8f49e257d858686dfe3c40144599dbdf3a697fe81601c6d6a3bb56892a8b0a1af7b1229216b43190d5f99e75dc1104b55df365647f22d9af3b9b59e25f5cbd85
+  metadata.gz: 117a31d340940d5c206576cf81f1571e1b6025811624a6b6ac1b1c074b5b0b8fd29e398c04e0890778132f82b381e50a110b32cb028ba823a7a0f233d10f527b
+  data.tar.gz: 44be44b781e6969014462c42cfe2e4e584eab62cd82ad04316b2afd8cbf0f654cb52221a7836ae920da59b879d4c790b08dfbdb712aa4fadc4dc0087c971e196

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9
+  - 2.0

data/.yardopts

@@ -0,0 +1,7 @@
+--title LocaSMS Documentation
+--private
+--protected
+
+lib/**/*.rb
+README.md
+LICENSE.txt

data/Guardfile

@@ -0,0 +1,5 @@
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb})
+  watch(%r{^lib/(.+)\.rb})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb') { "spec" }
+end

data/README.md

@@ -1,6 +1,6 @@
-# Locasms
+# locasms [![Build Status](https://travis-ci.org/mcorp/locasms.png?branch=master)](https://travis-ci.org/mcorp/locasms) [![Dependency Status](https://gemnasium.com/mcorp/locasms.png)](https://gemnasium.com/mcorp/locasms)
 
-TODO: Write a gem description
+Client to consume [LocaSMS api's][0].
 
 ## Installation
 
@@ -18,7 +18,43 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Simple example:
+
+```ruby
+require 'locasms'
+
+cli = LocaSMS::Client.new login: 'LOGIN', password: 'PASSWORD'
+
+# delivering message to one mobile
+cli.deliver 'my message', '1155559999'
+
+# delivering the same message to multiple mobliles at once
+cli.deliver 'my message', '1199998888,5500002222'
+cli.deliver 'my message', '1199998888', '5500002222'
+cli.deliver 'my message', ['1199998888', '5500002222']
+cli.deliver 'my message', %w(1199998888 5500002222)
+
+# scheluling the deliver of a message to one mobile
+cli.deliver_at 'my message', '2013-10-12 20:33:00', '1155559999'
+
+# scheluling the deliver of a message to multiple mobiles at once
+cli.deliver_at 'my message', '2013-10-12 20:33:00', '1199998888,5500002222'
+cli.deliver_at 'my message', '2013-10-12 20:33:00', '1199998888', '5500002222'
+cli.deliver_at 'my message', '2013-10-12 20:33:00', ['1199998888', '5500002222']
+cli.deliver_at 'my message', '2013-10-12 20:33:00', %w(1199998888 5500002222)
+
+# geting the remaining balance
+cli.balance
+
+# geting the status of a campaign
+cli.campaign_status '0000'
+
+# holding a campaign
+cli.campaign_hold '0000'
+
+# resuming a campaign
+cli.campaign_release '0000'
+```
 
 ## Contributing
 
@@ -27,3 +63,5 @@ TODO: Write usage instructions here
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+[0]: http://locasms.com.br/#page_2/

data/Rakefile

@@ -1 +1,17 @@
-require "bundler/gem_tasks"
+require 'rubygems'
+require 'bundler'
+
+Bundler.setup
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+end
+
+desc 'Open an irb session preloaded with this library'
+task :console do
+  sh 'bundle exec irb -rubygems -I lib -r locasms.rb'
+end
+
+task :default => :console

data/lib/locasms/client.rb

@@ -0,0 +1,80 @@
+module LocaSMS
+
+  # Client to interact with LocaSMS API
+  class Client
+    # Default API address
+    ENDPOINT = 'http://173.44.33.18/painel/api.ashx'
+
+    attr_reader :login, :password
+
+    # @param [String] login authorized user
+    # @param [String] password access password
+    # @param [Hash] opts
+    # @option opts :rest_client (RestClient) client to be used to handle http requests
+    def initialize(login, password, opts={})
+      @login    = login
+      @password = password
+
+      @rest = opts[:rest_client]
+    end
+
+    # Sends a message to one or more mobiles
+    # @param [String] message message to be sent
+    # @param [String,Array<String>] mobiles number of the mobiles to address the message
+    # @return [String] campaign id on success
+    def deliver(message, *mobiles)
+      rest.get :sendsms, msg: message, numbers: mobiles.join(',')
+    end
+
+    # Schedule the send of a message to one or more mobiles
+    # @param [String] message message to be sent
+    # @param [Time,DateTime,Fixnum,String] datetime
+    # @param [String,Array<String>] mobiles number of the mobiles to address the message
+    # @return UNDEF
+    def deliver_at(message, datetime, *mobiles)
+      datetime = Time.at(datetime)    if datetime.is_a? Fixnum
+      datetime = Time.parse(datetime) if datetime.is_a? String
+      datetime = datetime.to_time     if datetime.respond_to? :to_time
+
+      date, time = datetime.strftime('%d/%m/%Y|%H:%M').split('|')
+      rest.get :sendsms, numbers: mobiles.join(','), jobdate: date, jobtime: time
+    end
+
+    # Get de current amount of sending credits
+    # @return [Fixnum] returns the balance on success
+    def balance
+      rest.get :getbalance
+    end
+
+    # Gets the current status of the given campaign
+    # @param [String] id campaign id
+    # @return UNDEF
+    def campaign_status(id)
+      rest.get :getstatus, id: id
+    end
+
+    # Holds the given campaign to fire
+    # @param [String] id campaign id
+    # @return [TrueClass,FalseClass] returns true on success
+    def campaign_hold(id)
+      rest.get :holdsms, id: id
+    end
+
+    # Restart firing the given campaign
+    # @param [String] id campaign id
+    # @return [TrueClass,FalseClass] returns true on success
+    def campaign_release(id)
+      rest.get :releasesms, id: id
+    end
+
+  private
+
+    # Gets the current RestClient to handle http requests
+    # @return [RestClient] you can set on class creation passing it on the options
+    # @private
+    def rest
+      @rest ||= RestClient.new ENDPOINT, lgn: login, pwd: password
+    end
+  end
+
+end

data/lib/locasms/rest_client.rb

@@ -0,0 +1,57 @@
+module LocaSMS
+
+  # Class that handle http calls to LocaSMS api
+  # @see https://github.com/mcorp/locasms/wiki/A-API-de-envio List of avaiable services
+  class RestClient
+    attr_accessor :base_url, :base_params
+
+    # Creates a new instance of the RestClient class
+    # @param [String] base_url a well formed url
+    # @param [Hash] base_params base params to send on every call
+    def initialize(base_url, base_params={})
+      @base_url    = base_url
+      @base_params = base_params
+    end
+
+    # Performs a GET call for an action
+    # @param [String, Symbol] action the given action to perform
+    # @param [Hash] params given parameters to send
+    # @return [String]
+    #
+    # @example Calling with no extra parameters
+    #
+    #     client = LocaSMS::RestClient('http://localhost:3000', lgn: 'LOGIN', pwd: 'PASSWORD')
+    #     # => GET http://localhost:3000?lgn=LOGIN&pws=PASSWORD&action=getballance
+    #     client.get :getballance
+    #
+    # @example Calling with extra parameters
+    #
+    #     client = LocaSMS::RestClient('http://localhost:3000', lgn: 'LOGIN', pwd: 'PASSWORD')
+    #     # => GET http://localhost:3000?lgn=LOGIN&pws=PASSWORD&action=holdsms&id=345678
+    #     client.get :holdsms, id: 345678
+    #
+    # @see https://github.com/mcorp/locasms/wiki/A-API-de-envio#lista-das-a%C3%A7%C3%B5es-dispon%C3%ADveis List of avaiable actions
+    def get(action, params={})
+      params   = params_for action, params
+      response = ::RestClient.get base_url, params: params
+      JSON.parse(response) rescue response
+    end
+
+    # Composes the parameters hash
+    # @param [String, Symbol] action the given action to perform
+    # @param [Hash] params given parameters to send
+    # @return [Hash]
+    #
+    # @example
+    #
+    #    client = LocaSMS::RestClient('http://localhost:3000', lgn: 'LOGIN', pwd: 'PASSWORD')
+    #    client.params_for :ACTION, a: 1, b: 2
+    #    # => { action: :ACTION, lgn: 'LOGIN', pwd: 'PASSWORD', a: 1, b: 2 }
+    #
+    # @see https://github.com/mcorp/locasms/wiki/A-API-de-envio#lista-das-a%C3%A7%C3%B5es-dispon%C3%ADveis List of avaiable actions
+    def params_for(action, params={})
+      {action: action}.merge(base_params).merge(params)
+    end
+  end
+
+end

data/lib/locasms/version.rb

@@ -1,3 +1,3 @@
-module Locasms
-  VERSION = "0.1.0"
+module LocaSMS
+  VERSION = "0.1.1"
 end

data/lib/locasms.rb

@@ -1,6 +1,10 @@
 require "locasms/version"
 
-module Locasms
-  class Sender
-  end
+autoload :JSON,       'json'
+autoload :RestClient, 'rest_client'
+autoload :Logger,     'logger'
+
+module LocaSMS
+  autoload :Client,     'locasms/client'
+  autoload :RestClient, 'locasms/rest_client'
 end

data/locasms.gemspec

@@ -5,7 +5,7 @@ require 'locasms/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "locasms"
-  spec.version       = Locasms::VERSION
+  spec.version       = LocaSMS::VERSION
   spec.authors       = ["Adilson Carvalho"]
   spec.email         = ["lc.adilson@gmail.com"]
   spec.description   = %q{Cliente para o serviço de disparo de SMS da LocaSMS}
@@ -18,6 +18,24 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake', '~> 0.9.2'
+
+  # test stuff
+  spec.add_development_dependency 'rspec', '~> 2.5'
+  spec.add_development_dependency 'fuubar', '~> 1.1.0'
+
+  # run tests automatically
+  spec.add_development_dependency 'guard'
+  spec.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency 'growl'
+
+  # for documentation
+  spec.add_development_dependency 'yard'
+  spec.add_development_dependency 'redcarpet'
+
+  # for code coverage
+  spec.add_development_dependency 'simplecov'
+
+  spec.add_dependency 'rest-client', '~> 1.6'
 end

data/spec/lib/locasms/client_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe LocaSMS::Client do
+  let(:rest_client) { 'rest_client mock' }
+  subject { LocaSMS::Client.new :login, :password, rest_client: rest_client }
+
+  describe '.initialize' do
+    it { subject.login.should be(:login) }
+    it { subject.password.should be(:password) }
+  end
+
+  describe '#deliver' do
+    before(:each) do
+      rest_client.should_receive(:get)
+        .once
+        .with(:sendsms, msg: 'given message', numbers:'1188882222,5577770000')
+    end
+
+    it{ subject.deliver 'given message', '1188882222,5577770000'      }
+    it{ subject.deliver 'given message', %w(1188882222 5577770000)    }
+    it{ subject.deliver 'given message', '1188882222', '5577770000'   }
+    it{ subject.deliver 'given message', ['1188882222', '5577770000'] }
+  end
+
+  it '#deliver_at'
+
+  describe '#balance' do
+    it 'Should check param assignment' do
+      rest_client.should_receive(:get)
+        .once
+        .with(:getbalance)
+
+      subject.balance
+    end
+  end
+
+  context 'Testing all campaign based methods' do
+    def check_for(method)
+      rest_method = {
+        campaign_status: :getstatus,
+        campaign_hold: :holdsms,
+        campaign_release: :releasesms
+      }[method]
+
+      rest_client.should_receive(:get)
+        .once
+        .with(rest_method, id: '12345')
+
+      subject.send method, '12345'
+    end
+
+    it{ check_for :campaign_status  }
+    it{ check_for :campaign_hold    }
+    it{ check_for :campaign_release }
+  end
+
+end

data/spec/lib/locasms/rest_client_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe LocaSMS::RestClient do
+
+  describe '.initialize' do
+    context 'When giving proper initialization parameters' do
+      subject { LocaSMS::RestClient.new :url, :params }
+      it { subject.base_url.should be(:url) }
+      it { subject.base_params.should be(:params) }
+    end
+  end
+
+  describe '#get' do
+    it 'Is missing tests for get'
+  end
+
+  describe '#params_for' do
+    subject { LocaSMS::RestClient.new :url, { b1: 'X' } }
+
+    it{ subject.params_for(:action).should == {action: :action, b1: 'X'} }
+    it{ subject.params_for(:action, p1: 10).should == {action: :action, b1: 'X', p1: 10} }
+  end
+
+end

data/spec/spec.opts

@@ -0,0 +1,3 @@
+--colour
+--format Fuubar
+--backtrace

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require 'rubygems'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+# require 'coveralls'
+# require 'simplecov'
+
+# SimpleCov.start
+
+require 'locasms'
+require 'rspec'
+require 'time'
+
+RSpec.configure do |config|
+  # see spec.opts
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: locasms
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Adilson Carvalho
@@ -26,6 +26,104 @@ dependencies:
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: fuubar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: guard
+  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: guard-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: growl
+  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: yard
+  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: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -38,6 +136,34 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
 description: Cliente para o serviço de disparo de SMS da LocaSMS
 email:
 - lc.adilson@gmail.com
@@ -46,13 +172,22 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
+- .yardopts
 - Gemfile
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/locasms.rb
+- lib/locasms/client.rb
+- lib/locasms/rest_client.rb
 - lib/locasms/version.rb
 - locasms.gemspec
+- spec/lib/locasms/client_spec.rb
+- spec/lib/locasms/rest_client_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
 homepage: https://github.com/mcorp/locasms
 licenses:
 - MIT
@@ -77,4 +212,9 @@ rubygems_version: 2.0.6
 signing_key: 
 specification_version: 4
 summary: Cliente para o serviço de disparo de SMS da LocaSMS
-test_files: []
+test_files:
+- spec/lib/locasms/client_spec.rb
+- spec/lib/locasms/rest_client_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: