mxit-rails 0.3.4 → 0.4.0

data/lib/mxit-api.rb

@@ -0,0 +1,7 @@
+require "mxit_api/client"
+require "mxit_api/auth_token"
+require "mxit_api/exception"
+require "mxit_api/request_exception"
+
+module MxitApi
+end

data/lib/mxit-rails.rb

@@ -10,7 +10,4 @@ require "mxit_rails/page"
 module MxitRails
 end
 
-require "mxit_rails/mxit_api/api_client"
-require "mxit_rails/mxit_api/auth_token"
-require "mxit_rails/mxit_api/mxit_api_exception"
-require "mxit_rails/mxit_api/request_exception"
+require 'mxit-api'

data/lib/{mxit_rails/mxit_api → mxit_api}/auth_token.rb

@@ -1,4 +1,4 @@
-module MxitRails::MxitApi
+module MxitApi
   class AuthToken
     attr_reader :access_token, :type, :expires_in, :refresh_token, :expires_at,
       :refresh_token_expires_at

data/lib/{mxit_rails/mxit_api/api_client.rb → mxit_api/client.rb}

@@ -1,7 +1,8 @@
 require 'net/http'
 require 'uri'
+require 'json'
 
-module MxitRails::MxitApi
+module MxitApi
   class Client
     MXIT_AUTH_BASE_URI = 'https://auth.mxit.com'
     MXIT_AUTH_TOKEN_URI = MXIT_AUTH_BASE_URI + '/token'
@@ -20,7 +21,7 @@ module MxitRails::MxitApi
 
     def request_app_auth(scopes)
       if scopes.empty?
-        raise MxitRails::MxitApi::Exception.new("No scopes were provided.")
+        raise MxitApi::Exception.new("No scopes were provided.")
       end
 
       response = http_client(MXIT_AUTH_TOKEN_URI) do |http, path|
@@ -33,13 +34,7 @@ module MxitRails::MxitApi
         http.request(request)
       end
 
-      case response
-      when Net::HTTPSuccess then
-        @auth_token = AuthToken.new(JSON.parse(response.body))
-
-      else
-        raise MxitRails::MxitApi::RequestException.new(response.message, response.code)
-      end
+      @auth_token = AuthToken.new(handle_response(response))
     end
 
     # The user's response to the authorisation code request will be redirected to `redirect_uri`. If
@@ -50,7 +45,7 @@ module MxitRails::MxitApi
     # scopes - list of scopes to which access is required
     def user_code_request_uri(redirect_uri, state, scopes)
       if scopes.empty?
-        raise MxitRails::MxitApi::Exception.new("No scopes were provided.")
+        raise MxitApi::Exception.new("No scopes were provided.")
       end
 
       # build parameters
@@ -79,13 +74,7 @@ module MxitRails::MxitApi
         http.request(request)
       end
 
-      case response
-      when Net::HTTPSuccess then
-        @auth_token = AuthToken.new(JSON.parse(response.body))
-
-      else
-        raise MxitRails::MxitApi::RequestException.new(response.message, response.code)
-      end
+      @auth_token = AuthToken.new(handle_response(response))
     end
 
     def revoke_token(auth_token)
@@ -98,15 +87,12 @@ module MxitRails::MxitApi
         http.request(request)
       end
 
-      if response.code != '200'
-        raise MxitRails::MxitApi::RequestException.new(response.message, response.code)
-      end
+      handle_response(response)
     end
 
     def refresh_token(auth_token)
       if auth_token.refresh_token.nil?
-        raise MxitRails::MxitApi::Exception.new("The provided auth token doesn't have a refresh " +
-          "token.")
+        raise MxitApi::Exception.new("The provided auth token doesn't have a refresh token.")
       end
 
       response = http_client(MXIT_AUTH_TOKEN_URI) do |http, path|
@@ -119,20 +105,16 @@ module MxitRails::MxitApi
         http.request(request)
       end
 
-      case response
-      when Net::HTTPSuccess then
-        auth_token = AuthToken.new(JSON.parse(response.body))
-
-      else
-        raise MxitRails::MxitApi::RequestException.new(response.message, response.code)
-      end
+      handle_response(response)
     end
 
     ### API methods requiring authorisation.
 
     # When sending as the app the `message/send` scope is required otherwise `message/user`
-    def send_message(from, to, body, contains_markup, auth_token=nil)
-      auth_token = auth_token || @auth_token
+    def send_message(from, to, body, contains_markup, options={ spool: true,
+      spool_timeout: 60*60*24*7, auth_token: nil })
+
+      auth_token = options[:auth_token] || @auth_token
 
       if from == @app_name
         check_auth_token(auth_token, ["message/send"])
@@ -145,21 +127,22 @@ module MxitRails::MxitApi
         request = Net::HTTP::Post.new(path)
         set_api_headers(request, auth_token.access_token)
 
+        spool = options[:spool].nil? ? true : options[:spool]
+        spool_timeout = options[:spool_timeout] || 60*60*24*7
+
         request.body = {
           "Body" => body,
           "ContainsMarkup" => contains_markup,
           "From" => from,
-          "To" => to
-          # "Spool" => default(true)
-          # "SpoolTimeOut" => default(60*60*24*7)
+          "To" => to,
+          "Spool" => spool,
+          "SpoolTimeOut" => spool_timeout
         }.to_json
 
         http.request(request)
       end
 
-      if response.code != '200'
-        raise MxitRails::MxitApi::RequestException.new(response.message, response.code)
-      end
+      handle_response(response)
     end
 
     # The following filter parameters are available (only one can be specified at a time):
@@ -172,7 +155,7 @@ module MxitRails::MxitApi
     #   @Pending - Return all entries that is waiting to be accepted by the other party
     #   @Deleted - Return all entries that was deleted
     #   @Blocked - Return all entries that was blocked
-    def get_contact_list(filter, options={ :skip => nil, :count => nil, :auth_token => nil })
+    def get_contact_list(filter, options={ skip: nil, count: nil, auth_token: nil })
       auth_token = options[:auth_token] || @auth_token
       check_auth_token(auth_token, ["graph/read"])
 
@@ -180,8 +163,8 @@ module MxitRails::MxitApi
 
         parameters = { :filter => filter }
         # skip and count are optional
-        parameters[:skip] = skip if options[:skip]
-        parameters[:count] = count if options[:count]
+        parameters[:skip] = options[:skip] if options[:skip]
+        parameters[:count] = options[:count] if options[:count]
 
         request = Net::HTTP::Get.new(path + "?#{URI.encode_www_form(parameters)}")
         set_api_headers(request, auth_token.access_token)
@@ -189,13 +172,30 @@ module MxitRails::MxitApi
         http.request(request)
       end
 
-      case response
-      when Net::HTTPSuccess then
-        data = JSON.parse(response.body)
+      handle_response(response)
+    end
 
-      else
-        raise MxitRails::MxitApi::RequestException.new(response.message, response.code)
+    def recommend_app(callback_url, from_user_id, to_user_id, message, options={ auth_token: nil })
+      auth_token = options[:auth_token] || @auth_token
+      check_auth_token(auth_token, ["contact/recommend"])
+
+      response = http_client(MXIT_API_URI + "/user/recommend") do |http, path|
+
+        request = Net::HTTP::Post.new(path)
+        set_api_headers(request, auth_token.access_token)
+
+        request.body = {
+          "Application" => @app_name,
+          "CallbackUrl" => callback_url,
+          "FromUserId" => from_user_id,
+          "ToUserId" => to_user_id,
+          "Message" => message
+        }.to_json
+
+        http.request(request)
       end
+
+      handle_response(response)
     end
 
     def batch_notify_users(mxit_ids, message, contains_markup)
@@ -208,12 +208,12 @@ module MxitRails::MxitApi
       i = 0
       while i < mxit_ids.count
         current_batch = mxit_ids[i, batch_size]
-        i += batch_size
+        i += current_batch.count 
 
         to = current_batch.join(',')
         send_message(@app_name, to, message, contains_markup)
 
-        Rails.logger.info("Total users notified: " + current_batch.count.to_s)
+        Rails.logger.info("Total users notified: " + i.to_s)
       end
       Rails.logger.info('Finished notifying!')
     end
@@ -248,10 +248,32 @@ module MxitRails::MxitApi
 
       def check_auth_token(auth_token, scopes)
         if auth_token.nil?
-          raise MxitRails::MxitApi::Exception.new("No auth token has been set/provided.")
+          raise MxitApi::Exception.new("No auth token has been set/provided.")
         elsif not auth_token.has_scopes? scopes
-          raise MxitRails::MxitApi::Exception.new("The auth token doesn't have the required " +
-            "scope(s).")
+          raise MxitApi::Exception.new("The auth token doesn't have the required scope(s): " +
+            scopes.join(","))
+        end
+      end
+
+      def handle_response(response)
+        begin
+          data = JSON.parse(response.body)
+        rescue JSON::ParserError
+          data = {}
+        end
+
+        case response
+        when Net::HTTPSuccess then
+          data
+
+        when Net::HTTPBadRequest, Net::HTTPUnauthorized, Net::HTTPForbidden then
+          error_message = "#{response.code}::#{response.message}"
+          error_message += " - #{data["error"]}: #{data["error_description"]}" if not data.empty?
+          raise MxitApi::RequestException.new(error_message, response.code), error_message
+
+        else
+          raise MxitApi::RequestException.new(response.message, response.code),
+            "#{response.code}::#{response.message}"
         end
       end
 

data/lib/{mxit_rails/mxit_api/mxit_api_exception.rb → mxit_api/exception.rb}

@@ -1,7 +1,8 @@
-module MxitRails::MxitApi
+module MxitApi
   class Exception < Exception
     attr_reader :message
     def initialize(message)
+      super(message)
       @message = message
     end
   end

data/lib/{mxit_rails/mxit_api → mxit_api}/request_exception.rb

@@ -1,5 +1,5 @@
-module MxitRails::MxitApi
-  class RequestException < MxitRails::MxitApi::Exception
+module MxitApi
+  class RequestException < MxitApi::Exception
     attr_reader :code
     def initialize(message, code)
       super(message)

data/lib/mxit_rails/version.rb

@@ -1,3 +1,3 @@
 module MxitRails
-  VERSION = "0.3.4"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mxit-rails
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-09 00:00:00.000000000 Z
+date: 2012-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -90,15 +90,16 @@ files:
 - app/views/layouts/mxit.html.erb
 - app/views/mxit_rails/error.html.erb
 - config/routes.rb
+- lib/mxit-api.rb
 - lib/mxit-rails.rb
+- lib/mxit_api/auth_token.rb
+- lib/mxit_api/client.rb
+- lib/mxit_api/exception.rb
+- lib/mxit_api/request_exception.rb
 - lib/mxit_rails/controller_extensions.rb
 - lib/mxit_rails/descriptor.rb
 - lib/mxit_rails/engine.rb
 - lib/mxit_rails/exception.rb
-- lib/mxit_rails/mxit_api/api_client.rb
-- lib/mxit_rails/mxit_api/auth_token.rb
-- lib/mxit_rails/mxit_api/mxit_api_exception.rb
-- lib/mxit_rails/mxit_api/request_exception.rb
 - lib/mxit_rails/page.rb
 - lib/mxit_rails/railtie.rb
 - lib/mxit_rails/styles.rb