messagebird-texter 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cf440b4e60686b98901f49458beb54cc1821b141
-  data.tar.gz: 3aa3f9861a936d7f9d4855ccd2596a50ae3bdd14
+  metadata.gz: fc07ab86ed3cb2975eac7d34b645179ed9ba5ee1
+  data.tar.gz: c17963495165769db57330e4d5fe667612aa304b
 SHA512:
-  metadata.gz: 57c4f2f8da6c5c03e97f2e44b175377a20c1cf8a965ee9c8bfbea14e9aec446a1f4ad44941de7b5c0bf818d667d67b04009281047b01d0daeba7e9584f428546
-  data.tar.gz: 79a947dcc2293ac3e69f64254ed1a3cf768ae36a5dcc003a0836c6304eded9238ec9e476310a5f161fb6edf4d70a79d9c1587389224e5d09747eee2ec48498a9
+  metadata.gz: eb0554ccb0a830bbbd1a0f9066b9cef9c58873336e8b6fb7fc5af36c9fd3d7d6772c10c8104e95f190cdbfa679931c189e1a364c1f614d6a8bf9f07071409c97
+  data.tar.gz: 5a127efb3cd3bb2d99e5c372308ff3e04126d97a52bf655fee288f9d999ed3410492d23a91df69a865ac0bf8937623698ed4c87be0bbd28047fb60d8c0557294

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    messagebird-texter (0.0.1)
+    messagebird-texter (0.1.0)
       action-texter
       phony (~> 2.12)
 
@@ -12,6 +12,7 @@ GEM
       json
       phony (~> 2.12)
     addressable (2.3.8)
+    coderay (1.1.0)
     coveralls (0.8.5)
       json (~> 1.8)
       rest-client (>= 1.6.8, < 2)
@@ -28,9 +29,14 @@ GEM
     http-cookie (1.0.2)
       domain_name (~> 0.5)
     json (1.8.3)
+    method_source (0.8.2)
     mime-types (2.99)
     netrc (0.11.0)
     phony (2.15.10)
+    pry (0.10.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
     rake (10.4.2)
     rest-client (1.8.0)
       http-cookie (>= 1.0.2, < 2.0)
@@ -55,6 +61,7 @@ GEM
       json (~> 1.8)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.0)
+    slop (3.6.0)
     term-ansicolor (1.3.2)
       tins (~> 1.0)
     thor (0.19.1)
@@ -74,6 +81,7 @@ DEPENDENCIES
   bundler (~> 1.10)
   coveralls
   messagebird-texter!
+  pry
   rake (~> 10.0)
   rspec (~> 3.0)
   simplecov

data/README.md

@@ -1,31 +1,33 @@
 ![alt text](http://www.hitfoxgroup.com/downloads/hitfox_logo_with_tag_two_colors_WEB.png "Logo Hitfox Group")
 
 
-messagebird-sms
+messagebird-texter
 =======
 
 
 Description
 -----------
 
-Send text messages by means of the HTTP protocol with the service of https://www.messagebird.com, from your ruby app.
-​
+Create ActionMailer-like notifiers to send messages via the Messagebird REST API
+ 
+
 Usage
 ------------
 
-### Configuration
+### Configure the messenger
 
-Use `MessagebirdTexter.configure` to set `product_token`, `endpoint` and `path`
+Use `MessagebirdTexter.configure` to set `product_token`, `endpoint` and `path`. 
 
 ```ruby
 MessagebirdTexter.configure do |config|
-  config.product_token = 'YOUR_MESSAGEBIRD_API_TOKEN'
-  config.endpoint = 'https://rest.messagebird.com' # Messagebird default
-  config.path = '/messages' # Messagebird default
+  config.product_token = 'YOUR_MESSAGEBIRD_API_TOKEN'   
+  config.endpoint = 'https://rest.messagebird.com'     
+  config.path = '/messages'                             
 end
 ```
 
-Create a class that is inherited from `MessagebirdTexter::Messenger`.
+### Create a messanger class
+Create a class and inherit from `MessagebirdTexter::Messenger`.
 
 ```ruby
 class TextMessageNotifier < MessagebirdTexter::Messenger
@@ -33,11 +35,10 @@ end
 ```
 
 Now you can add your first welcome message.
-This can be as simple as:
 
 ```ruby
 class TextMessageNotifier < MessagebirdTexter::Messenger
-  default from: 'some string or mobile number'
+  default from: 'Hitfox'
 
   def welcome(recipient)
     @recipient = recipient
@@ -64,18 +65,71 @@ end
 
 In order to send your sms, you simply call the method and then call `deliver_now` on the return value.
 
-Calling the method returns a MessagebirdTexter Message object:
+Calling the method returns a `MessagebirdTexter::Message` object:
+
 ```ruby
 message = TextMessageNotifier.welcome(User.first)   # => Returns a MessagebirdTexter::Message object
-message.deliver_now
+response = message.deliver_now
+```
+
+### Response Example
+Delivering a message returns a `MessagebirdTexter::Response` object. 
+
+####On success
+
+```ruby
+=> response.body
+=> <MessagebirdTexter::Response::Body:0x007faaca1cfe90
+      @content="Some text",
+      @created_datetime="2015-12-09T21:43:23+00:00",
+      @datacoding="plain",
+      @direction="mt",
+		 @gateway=10,
+		 @href="https://rest.messagebird.com/messages/bd9e796045668a07b0bca95b78482250",
+		 @id="bd9e796045668a07b0bca95b78482250",
+		 @mclass=1,
+		 @originator="me",
+		 @recipients=
+		  {:totalCount=>1,
+		   :totalSentCount=>1,
+		   :totalDeliveredCount=>0,
+		   :totalDeliveryFailedCount=>0,
+		   :items=>
+		    [{:recipient=>491759332902, :status=>"sent", :statusDatetime=>"2015-12-09T21:43:23+00:00"}]},
+		 @reference=nil,
+		 @scheduled_datetime=nil,
+		 @type="sms",
+		 @validity=nil>
+
+=> response.body.recipients
+=> <OpenStruct total_count=1, 
+				   total_sent_count=1, 
+				   total_delivered_count=0, 
+				   items=[
+				   		#<OpenStruct recipient=491759332902, 
+				   				       status="sent", 
+				   						status_datetime=#<Date: 2015-12-09 ((2457366j,0s,0n),+0s,2299161j)>>]>
+
+```
+
+###On failure
+
+```ruby
+=> response.error
+=> <MessagebirdTexter::Response::Error:0x007fa3d0c39738
+   @errors=[{:code=>25, :description=>"Not enough balance", :parameter=>nil}]>
 ```
 
+
+
+
+
 Installation
 ------------
 
-If you user bundler, then just add 
+If you use bundler, then just add 
 ```ruby
-$ gem 'messagebird-sms'
+$ gem 'messagebird-texter'
 ```
 to your Gemfile and execute
 ```
@@ -83,23 +137,33 @@ $ bundle install
 ```
 or without bundler
 ```
-$ gem install messagebird-sms
+$ gem install messagebird-texter
 ```
 
 Upgrade
 -------
 ```
-$ bundle update messagebird-sms
+$ bundle update messagebird-texter
 ```
 or without bundler
 
 ```
-$ gem update messagebird-sms
+$ gem update messagebird-texter
 ```
 ​
 Changelog
 ---------
 
+###0.0.1 (2015-12-09)
+Intilial release
+
+###0.0.2 (2015-12-10)
+Minor fixes, readme update
+
+###0.1.0 (2015-12-10)
+- Completly remove validators, api handles errors
+- readme update
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/HitFox/messagebird-sms. 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.

data/lib/messagebird_texter/gem_version.rb

@@ -6,8 +6,8 @@ module MessagebirdTexter
 
   module VERSION
     MAJOR = 0
-    MINOR = 0
-    TINY  = 2
+    MINOR = 1
+    TINY  = 0
     PRE   = nil
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join('.')

data/lib/messagebird_texter/message.rb

@@ -1,5 +1,4 @@
 require 'json'
-require 'messagebird_texter/validator/message'
 
 module MessagebirdTexter
   class Message < ActionTexter::Message
@@ -11,10 +10,12 @@ module MessagebirdTexter
       JSON.generate(recipients: to,
                     originator: from,
                     body: body)
+
+
     end
 
     def valid?
-      MessagebirdTexter::Validator::Message.new self
+      true
     end
   end
 end

data/lib/messagebird_texter/request.rb

@@ -1,5 +1,4 @@
 require 'messagebird_texter/response'
-require 'messagebird_texter/validator/request'
 
 module MessagebirdTexter
   class Request < ActionTexter::Request
@@ -15,16 +14,11 @@ module MessagebirdTexter
     end
 
     def perform
-      return unless valid?
       uri = URI.parse(@endpoint)
       Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == 'https') do |http|
         @response = Response.new(http.post(@path, body, 'Authorization' => "AccessKey #{@api_key}", 'Content-Type' => 'application/json'))
       end
       response
     end
-
-    def valid?
-      MessagebirdTexter::Validator::Request.new
-    end
   end
 end

data/lib/messagebird_texter/response/body.rb

@@ -19,21 +19,21 @@ module MessagebirdTexter
                   :recipients
 
       def initialize(body)
-        @parsed_body        = JSON.parse(body, symbolize_names: true)
-        @id                 = @parsed_body[:id]
-        @href               = @parsed_body[:href]
-        @direction          = @parsed_body[:direction]
-        @type               = @parsed_body[:type]
-        @originator         = @parsed_body[:originator]
-        @content            = @parsed_body[:body]
-        @reference          = @parsed_body[:reference]
-        @validity           = @parsed_body[:validity]
-        @gateway            = @parsed_body[:gateway]
-        @datacoding         = @parsed_body[:datacoding]
-        @mclass             = @parsed_body[:mclass]
-        @scheduled_datetime = @parsed_body[:scheduledDatetime]
-        @created_datetime   = @parsed_body[:createdDatetime]
-        @recipients         = @parsed_body[:recipients]
+        parsed_body         = JSON.parse(body, symbolize_names: true)
+        @id                 = parsed_body[:id]
+        @href               = parsed_body[:href]
+        @direction          = parsed_body[:direction]
+        @type               = parsed_body[:type]
+        @originator         = parsed_body[:originator]
+        @content            = parsed_body[:body]
+        @reference          = parsed_body[:reference]
+        @validity           = parsed_body[:validity]
+        @gateway            = parsed_body[:gateway]
+        @datacoding         = parsed_body[:datacoding]
+        @mclass             = parsed_body[:mclass]
+        @scheduled_datetime = parsed_body[:scheduledDatetime]
+        @created_datetime   = parsed_body[:createdDatetime]
+        @recipients         = parsed_body[:recipients]
       end
 
       def scheduled_datetime
@@ -54,6 +54,8 @@ module MessagebirdTexter
         ) unless @recipients.nil?
       end
 
+      private
+
       def items
         @recipients[:items].map do |i|
           OpenStruct.new(item(i))

data/messagebird-sms.gemspec

@@ -23,6 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'webmock', '~> 1.0'
+  spec.add_development_dependency 'pry'
 
   if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0')
     spec.add_runtime_dependency 'phony', '~> 2.12'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: messagebird-texter
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - oliverzeyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-12-09 00:00:00.000000000 Z
+date: 2015-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: phony
   requirement: !ruby/object:Gem::Requirement
@@ -122,8 +136,6 @@ files:
 - lib/messagebird_texter/response.rb
 - lib/messagebird_texter/response/body.rb
 - lib/messagebird_texter/response/error.rb
-- lib/messagebird_texter/validator/message.rb
-- lib/messagebird_texter/validator/request.rb
 - lib/messagebird_texter/version.rb
 - messagebird-sms.gemspec
 homepage: https://github.com/HitFox/messagebird-sms

data/lib/messagebird_texter/validator/message.rb

@@ -1,57 +0,0 @@
-require 'phony'
-module MessagebirdTexter
-  module Validator
-    class Message
-      class FromTooLong < ArgumentError; end
-      class FromMissing < ArgumentError; end
-      class ToMissing < ArgumentError; end
-      class BodyMissing < ArgumentError; end
-      class BodyTooLong < ArgumentError; end
-      class ToUnplausible < ArgumentError; end
-
-      attr_reader :message
-
-      def initialize(message)
-        @message = message
-        validate
-      end
-
-      def validate
-        fail FromMissing, 'The value for the from attribute is missing.' unless sender_present?
-        fail FromTooLong, 'The value for the sender attribute must contain 1..11 characters.' unless sender_length?
-        fail ToMissing, 'The value for the to attribute is missing.' unless receiver_present?
-        fail BodyMissing, 'The body of the message is missing.' unless body_present?
-        fail BodyTooLong, 'The body of the message has a length greater than 160.' unless body_correct_length?
-        fail ToUnplausible, "The given value for the to attribute is not a plausible phone number.\nMaybe the country code is missing." unless receiver_plausible?
-      end
-
-      def receiver_plausible?
-        receiver_present? && Phony.plausible?(message.to)
-      end
-
-      def receiver_present?
-        !message.to.nil? && !message.to.empty?
-      end
-
-      def sender_present?
-        !message.from.nil? && !message.from.empty?
-      end
-
-      def sender_length?
-        sender_present? && message.from.length <= 11
-      end
-
-      def body_present?
-        !message.body.nil? && !message.body.empty?
-      end
-
-      def body_correct_length?
-        body_present? && message.body.length <= 160
-      end
-
-      def product_token_present?
-        !MessagebirdTexter.config.product_token.nil? && !MessagebirdTexter.config.product_token.empty?
-      end
-    end
-  end
-end

data/lib/messagebird_texter/validator/request.rb

@@ -1,25 +0,0 @@
-module MessagebirdTexter
-  module Validator
-    class Request
-      class ProductTokenMissing < ArgumentError; end
-      class EndpointMissing < ArgumentError; end
-      class PathMissing < ArgumentError; end
-      class ContentTypeMissing < ArgumentError; end
-
-      def initialize
-        @endpoint     = MessagebirdTexter.config.endpoint
-        @path         = MessagebirdTexter.config.path
-        @content_type = MessagebirdTexter.config.content_type
-        @api_key      = MessagebirdTexter.config.product_token
-        validate
-      end
-
-      def validate
-        fail EndpointMissing, "Please provide an valid api endpoint.\nIf you leave this config blank, the default will be set to https://rest.sms-service.org  ." if @endpoint.nil? || @endpoint.empty?
-        fail ContentTypeMissing, 'Please provide a valid content_type! Defaults to application/json' if @content_type.nil? || @content_type.empty?
-        fail PathMissing, "Please provide an valid api path.\nIf you leave this config blank, the default will be set to /message." if @path.nil? || @path.empty?
-        fail ProductTokenMissing, "Please provide an valid product key.\nAfter signup at https://www.messagebird.com/, you will find one in your settings." if @api_key.nil?
-      end
-    end
-  end
-end