direct_sms 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f04ea0f7b6fddd268fa86242a77714acf8507370
-  data.tar.gz: 1118444d144bb0b47209f92b5efc2d82f0223412
+  metadata.gz: 48444dde721065342314bd1c75df0e7fa9c05be3
+  data.tar.gz: e3e216b10101be0217e6243a2c751e0a3ded3bec
 SHA512:
-  metadata.gz: 786f6aef3752547bf661eb2eb3145d1a0e49c1a9f6326c72c2a52621cf8d7ced34bed1e70fe95827d5e46dc09a6155a7b28e6f883aed12c7ff507e3d6c27ab37
-  data.tar.gz: 4c37f07dc4ff1486a406fe0ddadeafb800fa1c0f708e08069a9485fccd2035f42211e7aabec69b6b6439b304f1e7f6d55fd89162d58a3acab997e972c6fad342
+  metadata.gz: 0d797e9a70867444ba43e4b48380450eb33913c906b48935ce1ae871a57945c313479d33df78c4fcaf495f7468f7702befbb426db22e891f2ab24b99f8a1b245
+  data.tar.gz: 066ddda4b80b359cd01eaf76cf8bf4f16769924741a828ef368ecae3c8a72b9c619aad01dd373c5b833e30021d840d94282c962bf4f65c97072516b3091231eb

data/README.md

@@ -1,8 +1,9 @@
 # DirectSms
 
-TODO: Write a gem description
+DirectSms is a wrapper for using the api offered by directsms.com.au. The complete documentation can be downloaded 
+here: http://www.directsms.com.au/api/HTTP_API.pdf
 
-## Installation
+## Installation & Usage
 
 Add this line to your application's Gemfile:
 
@@ -16,9 +17,37 @@ Or install it yourself as:
 
     $ gem install direct_sms
 
-## Usage
+To start using DirectSms, you'll need a username and a password. If you read the directsms docs, they support passing a 
+connectionid as well. This is not supported for now.
 
-TODO: Write usage instructions here
+### Getting your remaining balance
+
+To get your account's balance, simply:
+
+    sms = DirectSms::Message.new(username, password)
+    response = sms.balance
+    response.body # -> credits: 300.00
+
+### Sending an SMS
+
+To send an sms, you need to set the ff. attributes:
+
+* message - The content of your sms message
+* type - Only accepts two values; "1-way" & "2-way"
+* to - The recipient/s of the message
+* message_id - A unique identifier for the message. Used for tracking the reply of the receiver.
+* sender_id - Used for 1-way sms sending
+
+      sms = DirectSms::Message.new(username, password)
+      sms.message = "Hello, world!"
+      sms.type = "2-way" # -> enables the receiver to reply
+      sms.to = "+639919302930" # -> to send to multiple recipients, use "," as delimiter.
+      sms.messageid = "<id>"
+      sms.send_message
+
+### Errors
+
+If you've found any errors on the documentation as well as the code, feel free to contact me on my email.
 
 ## Contributing
 

data/direct_sms.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["markchav3z@gmail.com"]
   spec.summary       = %q{Wrapper for DirectSMS API}
   spec.description   = %q{Wrapper for DirectSMS API}
-  spec.homepage      = "https://github.com/mrkjlchvz/directsms"
+  spec.homepage      = "https://github.com/mrkjlchvz/directsms_ruby"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")

data/lib/direct_sms/version.rb

@@ -1,3 +1,3 @@
 module DirectSms
-  VERSION = "0.0.1"
+  VERSION = "0.0.3"
 end

data/lib/direct_sms.rb

@@ -7,27 +7,36 @@ module DirectSms
 
     base_uri "api.directsms.com.au"
     attr_accessor :message, :to, :max_segments, :type, :message_id
+    attr_accessor :username, :password
 
-    def initialize(username, password, attrs = {})
-      @options = { username: username, password: password }
+    def initialize(attrs = {})
       attrs.each { |k, v| self.send("#{k}=", v) }
     end
     
-    def balance
-      options = { query: @options }
-      self.class.get("/s3/http/get_balance", options)
+    def credit_balance
+      options = { query: fetch_credentials }
+      response = self.class.get("/s3/http/get_balance", options) # returns credit: 50.0
+      response = response.split(" ").last
+
+      response
     end
 
     def send_message
       options = {
-        query: @options.merge(message: @message,
-                              to: @to,
-                              max_segments: @max_segments, 
-                              type: @type,
-                              messageid: @message_id)
+        query: fetch_credentials.merge(message: message,
+                              to: to,
+                              max_segments: max_segments, 
+                              type: type,
+                              messageid: message_id)
       }
 
       self.class.get("/s3/http/send_message", options)
     end
+
+    private
+
+    def fetch_credentials
+      { username: username, password: password }
+    end
   end
 end

data/spec/lib/direct_sms_spec.rb

@@ -10,14 +10,14 @@ describe DirectSms do
       stub_request(:get, "http://api.directsms.com.au/s3/http/get_balance?password=#{password}&username=#{username}").
       to_return(:status => 200, :body => "credit: 300.00", :headers => {})
 
-      sms = DirectSms::Message.new(username, password)
-      expect(sms.balance.body).to eq "credit: 300.00"
+      sms = DirectSms::Message.new(username: username, password: password)
+      expect(sms.credit_balance.body).to eq "credit: 300.00"
     end
   end
 
   describe "sending sms" do
     it 'attributes can be set on new' do
-      sms = DirectSms::Message.new(username, password, :type => "2-way", :max_segments => 20)
+      sms = DirectSms::Message.new(username: username, password: password, :type => "2-way", :max_segments => 20)
 
       expect(sms.max_segments).to eq 20
       expect(sms.type).to eq "2-way"
@@ -27,7 +27,7 @@ describe DirectSms do
       stub_request(:get, "http://api.directsms.com.au/s3/http/send_message?max_segments=10&message=This%20is%20a%20test&password=password&to=%2B639178574111&messageid=&type=2-way&username=username").
         to_return(:status => 200, :body => "id: 1234567890", :headers => {})
 
-      sms = DirectSms::Message.new(username, password, :type => "2-way", :max_segments => 10)
+      sms = DirectSms::Message.new(username: username, password: password, :type => "2-way", :max_segments => 10)
       sms.message = "This is a test"
       sms.to = "+639178574111"
 

metadata

@@ -1,83 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: direct_sms
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Mark Chavez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-03 00:00:00.000000000 Z
+date: 2014-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rake
   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: 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: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Wrapper for DirectSMS API
@@ -88,8 +88,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
+- ".gitignore"
+- ".rspec"
 - Gemfile
 - LICENSE
 - LICENSE.txt
@@ -101,7 +101,7 @@ files:
 - lib/direct_sms/version.rb
 - spec/lib/direct_sms_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/mrkjlchvz/directsms
+homepage: https://github.com/mrkjlchvz/directsms_ruby
 licenses:
 - MIT
 metadata: {}
@@ -111,17 +111,17 @@ 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.2.0
+rubygems_version: 2.2.1
 signing_key: 
 specification_version: 4
 summary: Wrapper for DirectSMS API