sms_gateway_to 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0cb120782e2fdfd35481deeb0abaf200ac28637e
-  data.tar.gz: 9deb9fd1b583301d65864bdeac143044a4658cbd
+  metadata.gz: 07f4d377903576016a482c4e3ef4d8324f9be504
+  data.tar.gz: f2002aaad7c3890f892e7351cb79589289001c9b
 SHA512:
-  metadata.gz: c28d67205040f135b76e037b29685c2aeb9e6885e9aba97eb362917e73320de580bacfd6225a38433002cdf99fd4b7d71af0566d93a9d6e4e577966b409e3a83
-  data.tar.gz: 72cb7780ab54b6e8edb64575492a4c64af3fc6d12a664c8441b11765a368b896057da1faff1c307c05d238648e7e076f1f32bc393faff18c49e1a56216a2d8dd
+  metadata.gz: e0d8773873d9ab6a690df0861ba237558f08f485957af9b73ad757c7cb2e0344ebe1323baff2d96f92012a4ee8c8c94bcb6c9cce31da2f18e0eea07b7aacf703
+  data.tar.gz: 5fe73131a62775c045822a7fbf2ed824f527888b66258c93a107425e5a25389f64e03170ad8afaed10f01ed5579b63ced93565560529b7898e355d6a0080029d

data/.gitignore

@@ -8,3 +8,4 @@
 /spec/reports/
 /tmp/
 .DS_Store
+*.sw*

data/README.md

@@ -1,8 +1,6 @@
 # SmsGatewayTo
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/sms_gateway_to`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+SMSGatewayTo gem is a ruby wrapper for the smsgateway.to service.
 
 ## Installation
 
@@ -22,7 +20,43 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+To use the gem as a standalone library
+
+```ruby
+	# Product token aka API key from smsgateway.to 
+	
+	client = SmsGatewayTo::Client.new("producttoken") 
+
+	# To send an sms 
+	# from - The from address in the sms
+	# to   - The number you want to send the sms to
+	# message - The text message you want to send
+
+	client.send_message(from, to, message)
+```
+
+If you are using it with rails
+
+
+1. Create a smsgateway.yaml file in the config folder of the rails app
+
+```ruby
+	Sample smsgateway.yaml file
+	
+	development:
+		token: dev-token
+	production:
+		token: production-token
+	test:
+		token: test-token
+```
+
+2. The Gem will automatically chose the right token based on the environment.
+
+```ruby
+	client = SmsGatewayto.client # returns default client based on the environment
+	client.send_message(from, to, message)
+```
 
 ## Development
 
@@ -32,7 +66,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/sms_gateway_to. 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.
+Bug reports and pull requests are welcome on GitHub at https://github.com/h0lyalg0rithm/sms_gateway_to. 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

data/lib/sms_gateway_to/client.rb

@@ -1,17 +1,28 @@
-require 'httparty'
-
 module SmsGatewayTo
-	class Client
-		include HTTParty
-  		base_uri 'https://sgw01.cm.nl'
-  		attr_reader :product_token
+  class Client
+    include HTTParty
+    base_uri 'https://sgw01.cm.nl'
+    attr_reader :product_token
+
+    def initialize(product_token)
+      @product_token = product_token
+    end
+
+    def send_message(from, to, message)
+      self.class.get("/gateway.ashx", { query: {producttoken: @product_token, from: from, to: to, body: message}})
+    end
+
+    def send_message!(from, to, message)
+      response = send_message(from, to, message)
+      unless response.nil? || response.empty?
+        handle_error(response)
+      end
+    end
 
-  		def initialize(product_token)
-  			@product_token = product_token
-  		end
+    private
 
-  		def send_message(from, to, message)
-		    self.class.get("/gateway.ashx", { query: {producttoken: @product_token, from: from, to: to, body: message}})
-		  end
-	end
-end
+    def handle_error(response)
+      SmsGatewayTo::ErrorHandler.new(response).response
+    end
+  end
+end

data/lib/sms_gateway_to/config.rb

@@ -1,8 +1,8 @@
 module SmsGatewayTo
-	class Config
-		attr_reader :token
-		def initialize(cred)
-			@token = cred['token']
-		end
-	end
-end
+  class Config
+    attr_reader :token
+    def initialize(cred)
+      @token = cred['token']
+    end
+  end
+end

data/lib/sms_gateway_to/error_handler.rb

@@ -0,0 +1,24 @@
+module SmsGatewayTo
+  class ErrorHandler
+    attr_accessor :error
+     
+    def initialize(error)
+      @error = error
+    end
+
+    def response
+      case @error
+      when /Error: ERROR Parameter 'body' is required/
+        raise SmsGatewayTo::ParameterError.new('Body is required')
+      when /Error: ERROR Parameter \'(\w+)\'/
+        raise SmsGatewayTo::ParameterError.new("#{$1} is invalid")
+      when /Error: ERROR No sender name provided/
+        raise SmsGatewayTo::ParameterError.new("Sender name is required")
+      when /Error: ERROR (.+)/
+        raise SmsGatewayTo::StandardError.new("#{$1}")
+      else raise SmsGatewayTo::StandardError 
+      end
+    end
+
+  end
+end

data/lib/sms_gateway_to/exceptions.rb

@@ -0,0 +1,4 @@
+module SmsGatewayTo
+  class StandardError < StandardError; end
+  class ParameterError < StandardError; end
+end

data/lib/sms_gateway_to/rails.rb

@@ -12,7 +12,7 @@ module SmsGatewayTo
 
   module Rails
 
-  	def self.setup
+    def self.setup
       load_yaml_config
       nil
     end
@@ -44,4 +44,4 @@ module SmsGatewayTo
     end
   end
 
-end
+end

data/lib/sms_gateway_to/version.rb

@@ -1,3 +1,3 @@
 module SmsGatewayTo
-  VERSION = "0.1.0"
+  VERSION = '0.2.0'
 end

data/lib/sms_gateway_to.rb

@@ -1,27 +1,29 @@
-require "sms_gateway_to/version"
-require "sms_gateway_to/rails"
-require "sms_gateway_to/client"
-require "sms_gateway_to/config"
+require 'httparty'
+require 'sms_gateway_to/version'
+require 'sms_gateway_to/rails'
+require 'sms_gateway_to/client'
+require 'sms_gateway_to/config'
+require 'sms_gateway_to/error_handler'
+require 'sms_gateway_to/exceptions'
 
 module SmsGatewayTo
+  class << self
+    attr_accessor :config
+    @@config = nil
+    def configure(credentials)
+      @@config = SmsGatewayTo::Config.new(credentials)
+      @@client = build_client
+    end
+    def config
+      @@config
+    end
 
-	class << self
-		attr_accessor :config
-		@@config = nil
-		def configure(credentials)
-			@@config = SmsGatewayTo::Config.new(credentials)
-			@@client = build_client
-		end
-		def config
-			@@config
-		end
+    def client
+      @@client
+    end
 
-		def client
-			@@client
-		end
-
-		def build_client
-			SmsGatewayTo::Client.new(@@config.token)
-		end
-	end
-end
+    def build_client
+      SmsGatewayTo::Client.new(@@config.token)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sms_gateway_to
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Suraj Shirvankar
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-30 00:00:00.000000000 Z
+date: 2016-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -100,6 +100,8 @@ files:
 - lib/sms_gateway_to.rb
 - lib/sms_gateway_to/client.rb
 - lib/sms_gateway_to/config.rb
+- lib/sms_gateway_to/error_handler.rb
+- lib/sms_gateway_to/exceptions.rb
 - lib/sms_gateway_to/rails.rb
 - lib/sms_gateway_to/version.rb
 - sms_gateway_to.gemspec