comufy 0.0.2b → 0.0.2.pre2

data/README.md

@@ -18,7 +18,7 @@ Or install it yourself as:
 
 ## Usage
 
-
+TODO:
 
 ## Contributing
 

data/comufyruby.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |gem|
   gem.version       = Comufy::VERSION
   gem.authors       = %w(plcstevens)
   gem.email         = %w(philip@tauri-tec.com)
-  gem.description   = %q{}
-  gem.summary       = %q{}
+  gem.description   = %q{This library can be used with Heroku}
+  gem.summary       = %q{This library allows customers to interact with the Comufy backend and perform common operations.}
   gem.homepage      = "https://github.com/plcstevens/comufyruby"
 
   gem.files         = `git ls-files`.split($/)

data/example/comufy_example.rb

@@ -0,0 +1,30 @@
+require 'comufy'
+
+USERNAME = ARGV[0]
+PASSWORD = ARGV[1]
+APPLICATION_NAME = ARGV[2]
+FACEBOOK_USER_ID = ARGV[3]
+
+connect = Comufy.connect(logger: "debug", username: USERNAME, password: PASSWORD)
+tag = Array[{name: :other_details, type: Comufy::Connector::STRING_TYPE}]
+puts connect.register_tags(APPLICATION_NAME, tag)
+
+# register a tag!
+#tag = Array[Hash[:name, :other_details, :type, Comufy::Connector::STRING_TYPE]]
+#puts connect.register_tags(APPLICATION_NAME, tag)
+
+# lets save a new user or if the user exists, update these tag details
+#tags = Hash[:other_details, 'test_details']
+#puts connect.store_user(APPLICATION_NAME, FACEBOOK_USER_ID, tags)
+
+# send a message to the user!
+#description = "description for you!"
+#content = "Content of the message goes here"
+#message_options = Hash.new
+#message_options[:private] = true
+#message_options[:link] = "www.example.com"
+#message_options[:name] = "test_name"
+#message_options[:description] = "test_description"
+#puts connect.send_facebook_message(
+#    APPLICATION_NAME, description, content, %w(FACEBOOK_USER_ID), message_options: message_options
+#)

data/lib/comufy/config.rb

@@ -2,7 +2,7 @@ module Comufy
   class Config
     include Comufy
 
-    attr_reader :username, :password, :base_api_url
+    attr_reader :user, :password, :base_api_url
     attr_accessor :access_token, :expiry_time
 
     # Sets the environment settings for Comufy to send and receive messages.
@@ -23,23 +23,23 @@ module Comufy
         yaml = Hash.new()
       end
 
-      username = params[:username]
+      user = params[:user]
       password = params[:password]
       no_env = params[:no_env]
       staging = params[:staging]
 
-      if (username and not password) or (password and not username)
+      if (user and not password) or (password and not user)
         raise "You must supply both a username and password."
       end
 
-      @username = username || yaml.fetch(:config, {})['username']
+      @user = user || yaml.fetch(:config, {})['user']
       @password = password || yaml.fetch(:config, {})['password']
       @access_token = no_env ? nil : ENV.fetch('access_token',  nil)
       @expiry_time = no_env ? nil : ENV.fetch('expiry_time',   nil)
 
       staging ?
-          @base_api_url = 'https://staging.comufy.com/xcoreweb/client?request=' :
-          @base_api_url = 'https://social.comufy.com/xcoreweb/client?request='
+          @base_api_url = 'https://staging.comufy.com/xcoreweb/client' :
+          @base_api_url = 'https://social.comufy.com/xcoreweb/client'
 
     end
   end

data/lib/comufy/connector.rb

@@ -2,20 +2,31 @@ module Comufy
   class Connector
     include Comufy
 
+    STRING_TYPE = :STRING
+    DATE_TYPE   = :DATE
+    GENDER_TYPE = :GENDER
+    INT_TYPE    = :INT
+    FLOAT_TYPE  = :FLOAT
+    LEGAL_TYPES = [STRING_TYPE, DATE_TYPE, GENDER_TYPE, INT_TYPE, FLOAT_TYPE]
+
+    NAME_TAG    = :name
+    TYPE_TAG    = :type
+    LEGAL_TAGS  = [NAME_TAG, TYPE_TAG]
+
     # There are a number of options you can pass to change default settings.
     #
     # With regards to the server to connect to, if you pass <tt>staging: true</tt> it'll use the Comufy
     # staging server, otherwise it'll default to using the social server.
     #
     # Concerning authentication, there are a number of ways to connect to the Comufy servers. You can
-    # pass in a username and password in the parameters, provide the location of a YAML file where these are
+    # pass in a user name and password in the parameters, provide the location of a YAML file where these are
     # specified or read in the <tt>access_token</tt> from your environment path. Please note that you can stop
     # the connector from reading your environment path by setting <tt>no_env</tt> to true. When doing this please
-    # ensure your username and password are correct, otherwise you'll not be able to connect to the Comufy servers.
+    # ensure your user name and password are correct, otherwise you'll not be able to connect to the Comufy servers.
     #
     # The YAML file provided should appear as:
     #   config:
-    #     username: username
+    #     user: user
     #     password: password
     #
     # = Example
@@ -26,8 +37,8 @@ module Comufy
     #   # do not use the environment path
     #   Comufy::Connector.new(no_env: true)
     #
-    #   # set the username and password yourself
-    #   Comufy::Connector.new(username: YOUR_USERNAME, password: YOUR_PASSWORD)
+    #   # set the user and password yourself
+    #   Comufy::Connector.new(user: YOUR_USERNAME, password: YOUR_PASSWORD)
     #
     #   # Or you can read in from a YAML file!
     #
@@ -38,15 +49,16 @@ module Comufy
       @config = Config.new(params)
       @logger = Logger.new(STDOUT)
       @logger.level = case params[:logger]
-                        when "info" then
-                          Logger::INFO
-                        when "warn" then
-                          Logger::WARN
-                        when "debug" then
-                          Logger::DEBUG
-                        else
-                          Logger::DEBUG
-    end
+        when "info" then
+          Logger::INFO
+        when "warn" then
+          Logger::WARN
+        when "debug" then
+          Logger::DEBUG
+        else
+          Logger::WARN
+      end
+
       # sanitize all output
       original_formatter = Logger::Formatter.new
       @logger.formatter = proc { |severity, datetime, progname, msg|
@@ -69,19 +81,19 @@ module Comufy
     def store_user app_name, uid, tags
       return false unless get_access_token
       if app_name.nil? or app_name.empty?
-        @logger.warn(progname = 'Comufy::Connect.store_user') {
+        @logger.warn(progname = 'Comufy::Connector.store_user') {
           'First parameter must be set to your application name.'
         }
         return false
       end
       if uid.nil? or uid.empty?
-        @logger.warn(progname = 'Comufy::Connect.store_user') {
+        @logger.warn(progname = 'Comufy::Connector.store_user') {
           'Second parameter must be a valid Facebook user ID.'
         }
         return false
       end
       if tags.nil? or not tags.is_a?(Hash)
-        @logger.warn(progname = 'Comufy::Connect.store_user') {
+        @logger.warn(progname = 'Comufy::Connector.store_user') {
           'Third parameter must be a hash of tag information for this uid.'
         }
         return false
@@ -101,41 +113,44 @@ module Comufy
       if message
         case message['cd']
           when 388 then
+            @logger.debug(progname = 'Comufy::Connector.store_user') {
+              "388 - Success! - data = #{data} - message = #{message}."
+            }
             return true
           when 475 then
-            @logger.debug(progname = 'Comufy::Connect.store_user') {
+            @logger.debug(progname = 'Comufy::Connector.store_user') {
               "475 - Invalid parameter provided. - data = #{data} - message = #{message}."
             }
-            @logger.warn(progname = 'Comufy::Connect.store_user') {
+            @logger.warn(progname = 'Comufy::Connector.store_user') {
               '475 - Invalid parameter provided.'
             }
           when 617 then
-            @logger.debug(progname = 'Comufy::Connect.store_user') {
+            @logger.debug(progname = 'Comufy::Connector.store_user') {
               "617 - Some of the tags passed are not registered. - data = #{data} - message = #{message}."
             }
-            @logger.warn(progname = 'Comufy::Connect.store_user') {
+            @logger.warn(progname = 'Comufy::Connector.store_user') {
               '617 - Some of the tags passed are not registered.'
             }
           when 632 then
-            @logger.debug(progname = 'Comufy::Connect.store_user') {
+            @logger.debug(progname = 'Comufy::Connector.store_user') {
               "632 - _ERROR_FACEBOOK_PAGE_NOT_FOUND - data = #{data} - message = #{message}."
             }
-            @logger.warn(progname = 'Comufy::Connect.store_user') {
+            @logger.warn(progname = 'Comufy::Connector.store_user') {
               '632 - _ERROR_FACEBOOK_PAGE_NOT_FOUND'
             }
           else
-            @logger.debug(progname = 'Comufy::Connect.store_user') {
+            @logger.debug(progname = 'Comufy::Connector.store_user') {
               "UNKNOWN RESPONSE - data = #{data} - message = #{message}."
             }
-            @logger.warn(progname = 'Comufy::Connect.store_user') {
+            @logger.warn(progname = 'Comufy::Connector.store_user') {
               "An error occurred when sending #{data}. Comufy returned #{message}. Please get in touch with Comufy if you cannot resolve the problem."
             }
         end
       else
-        @logger.debug(progname = 'Comufy::Connect.store_user') {
+        @logger.debug(progname = 'Comufy::Connector.store_user') {
           "Authentication failed - data = #{data}."
         }
-        @logger.warn(progname = 'Comufy::Connect.store_user') {
+        @logger.warn(progname = 'Comufy::Connector.store_user') {
           "Authentication failed when sending #{data}. Please get in touch with Comufy if you cannot resolve the problem."
         }
       end
@@ -145,11 +160,11 @@ module Comufy
     # TODO: IMPLEMENT METHOD
     def remove_user app_name, uid # :nodoc:
       return false unless get_access_token
-      @logger.debug(progname = 'Comufy::Connect.remove_user') {
+      @logger.debug(progname = 'Comufy::Connector.remove_user') {
         'METHOD_NOT_IMPLEMENTED'
       }
-      @logger.warn(progname = 'Comufy::Connect.remove_user') {
-          'METHOD_NOT_IMPLEMENTED'
+      @logger.warn(progname = 'Comufy::Connector.remove_user') {
+        'METHOD_NOT_IMPLEMENTED'
       }
       app_name
       uid
@@ -174,13 +189,13 @@ module Comufy
     def store_users app_name, uid_tags
       return false unless get_access_token
       if app_name.nil? or app_name.empty?
-        @logger.warn(progname = 'Comufy::Connect.store_users') {
+        @logger.warn(progname = 'Comufy::Connector.store_users') {
           'First parameter must be set to your application name.'
         }
         return false
       end
       if uid_tags.nil? or not uid_tags.is_a?(Hash)
-        @logger.warn(progname = 'Comufy::Connect.store_users') {
+        @logger.warn(progname = 'Comufy::Connector.store_users') {
           'Second parameter must be a hash where a key is a Facebook user ID and its value a hash of tags.'
         }
         return false
@@ -197,47 +212,64 @@ module Comufy
       if message
         case message['cd']
           when 388 then
+            @logger.debug(progname = 'Comufy::Connector.store_users') {
+              "388 - Success! - data = #{data} - message = #{message}."
+            }
             return true
           when 475 then
-            @logger.debug(progname = 'Comufy::Connect.store_users') {
+            @logger.debug(progname = 'Comufy::Connector.store_users') {
               "603 - Invalid parameter provided. - data = #{data} - message = #{message}."
             }
-            @logger.warn(progname = 'Comufy::Connect.store_users') {
+            @logger.warn(progname = 'Comufy::Connector.store_users') {
               '475 - Invalid parameter provided.'
             }
           when 617 then
-            @logger.debug(progname = 'Comufy::Connect.store_users') {
+            @logger.debug(progname = 'Comufy::Connector.store_users') {
               "617 - Some of the tags passed are not registered. - data = #{data} - message = #{message}."
             }
-            @logger.warn(progname = 'Comufy::Connect.store_users') {
+            @logger.warn(progname = 'Comufy::Connector.store_users') {
               '617 - Some of the tags passed are not registered.'
             }
           when 632 then
-            @logger.debug(progname = 'Comufy::Connect.store_users') {
+            @logger.debug(progname = 'Comufy::Connector.store_users') {
               "632 - _ERROR_FACEBOOK_PAGE_NOT_FOUND - data = #{data} - message = #{message}."
             }
-            @logger.warn(progname = 'Comufy::Connect.store_users') {
+            @logger.warn(progname = 'Comufy::Connector.store_users') {
               '632 - _ERROR_FACEBOOK_PAGE_NOT_FOUND'
             }
           else
-            @logger.debug(progname = 'Comufy::Connect.store_users') {
+            @logger.debug(progname = 'Comufy::Connector.store_users') {
               "UNKNOWN RESPONSE - data = #{data} - message = #{message}."
             }
-            @logger.warn(progname = 'Comufy::Connect.store_users') {
+            @logger.warn(progname = 'Comufy::Connector.store_users') {
               "An error occurred when sending #{data}. Comufy returned #{message}. Please get in touch with Comufy if you cannot resolve the problem."
             }
         end
       else
-        @logger.debug(progname = 'Comufy::Connect.store_users') {
+        @logger.debug(progname = 'Comufy::Connector.store_users') {
           "Authentication failed - data = #{data}."
         }
-        @logger.warn(progname = 'Comufy::Connect.store_users') {
+        @logger.warn(progname = 'Comufy::Connector.store_users') {
           "Authentication failed when sending #{data}. Please get in touch with Comufy if you cannot resolve the problem."
         }
       end
       false
     end
 
+
+    # Registering a Facebook application tag allows you to store data-fields about each one of your customers.
+    #
+    # * (String) +app_name+ - The application you wish to register the tags with.
+    # * (Hash) +tag+ - The tag you wish to register
+    #   * (String) +name+ - The name for the tag.
+    #   * (String) +type+ - Must be one of the following: STRING, DATE, GENDER, INT, FLOAT.
+    #
+    # = Example
+    #   Comufy::Connector.register_tag(YOUR_APPLICATION_NAME, name: 'dob', type: Connector::DATE_TYPE)
+    def register_tag app_name, tag = {}
+      register_tags(app_name, Array[tag])
+    end
+
     # Registering a Facebook application tag allows you to store data-fields about each one of your customers.
     #
     # * (String) +app_name+ - The application you wish to register the tags with.
@@ -249,39 +281,39 @@ module Comufy
     #   Comufy::Connector.register_tags(
     #     YOUR_APPLICATION_NAME,
     #     [{
-    #       'name' => 'dob',
-    #       'type' => 'DATE'
+    #       Connector::NAME_TAG: 'dob',
+    #       Connector::TYPE_TAG: Connector::DATE_TYPE
     #     },
     #     {
-    #       'name' => 'height',
-    #       'type' => 'FLOAT'
+    #       Connector::NAME_TAG: 'height',
+    #       Connector::TYPE_TAG: Connector::FLOAT_TYPE
     #     }]
     #   )
     def register_tags app_name, tags
       return false unless get_access_token
       if app_name.nil? or app_name.empty?
-        @logger.warn(progname = 'Comufy::Connect.register_tags') {
+        @logger.warn(progname = 'Comufy::Connector.register_tags') {
           'First parameter must be set to your application name.'
         }
         return false
       end
       if tags.nil? or not tags.is_a?(Array)
-        @logger.warn(progname = 'Comufy::Connect.register_tags') {
+        @logger.warn(progname = 'Comufy::Connector.register_tags') {
           'Second parameter must be an array containing hashes.'
         }
         return false
       end
       tags.each do |tag|
         tag.each do |key, value|
-          unless %w(name type).include?(key)
-            @logger.warn(progname = 'Comufy::Connect.register_tags') {
-              'You must have only two keys called "name" and "type".'
+          unless LEGAL_TAGS.include?(key)
+            @logger.warn(progname = 'Comufy::Connector.register_tags') {
+              "You must have only two keys called #{NAME_TAG} and #{TYPE_TAG}."
             }
             return false
           end
-          if key == "type" and not %w(STRING DATE GENDER INT FLOAT).include?(value)
-            @logger.warn(progname = 'Comufy::Connect.register_tags') {
-              'Your type must be one of these values: STRING, DATE, GENDER, INT, FLOAT.'
+          if (key == "type" or key == :type) and not LEGAL_TYPES.include?(value)
+            @logger.warn(progname = 'Comufy::Connector.register_tags') {
+              "Your type must be one of these values: #{LEGAL_TYPES.join(',')}."
             }
             return false
           end
@@ -299,48 +331,51 @@ module Comufy
       if message
         case message['cd']
           when 386 then
+            @logger.debug(progname = 'Comufy::Connector.register_tags') {
+              "386 - Success! - data = #{data} - message = #{message}."
+            }
             return true
           when 475 then
-            @logger.debug(progname = 'Comufy::Connect.register_tags') {
+            @logger.debug(progname = 'Comufy::Connector.register_tags') {
               "475 - Invalid parameters provided - data = #{data} - message = #{message}."
             }
-            @logger.warn(progname = 'Comufy::Connect.register_tags') {
+            @logger.warn(progname = 'Comufy::Connector.register_tags') {
               '475 - Invalid parameters provided'
             }
           when 603 then
-            @logger.debug(progname = 'Comufy::Connect.register_tags') {
+            @logger.debug(progname = 'Comufy::Connector.register_tags') {
               "603 - _ERROR_DOMAIN_APPLICATION_NAME_NOT_FOUND - data = #{data} - message = #{message}."
             }
-            @logger.warn(progname = 'Comufy::Connect.register_tags') {
+            @logger.warn(progname = 'Comufy::Connector.register_tags') {
               '603 - _ERROR_DOMAIN_APPLICATION_NAME_NOT_FOUND'
             }
           when 607 then
-            @logger.debug(progname = 'Comufy::Connect.register_tags') {
+            @logger.debug(progname = 'Comufy::Connector.register_tags') {
               "607 - _ERROR_UNAUTHORISED_ACTION - data = #{data} - message = #{message}."
             }
-            @logger.warn(progname = 'Comufy::Connect.register_tags') {
+            @logger.warn(progname = 'Comufy::Connector.register_tags') {
               '607 - _ERROR_UNAUTHORISED_ACTION'
             }
           when 618 then
-            @logger.debug(progname = 'Comufy::Connect.register_tags') {
+            @logger.debug(progname = 'Comufy::Connector.register_tags') {
               "618 - _ERROR_DOMAIN_APPLICATION_TAG_ALREADY_REGISTERED - data = #{data} - message = #{message}."
             }
-            @logger.warn(progname = 'Comufy::Connect.register_tags') {
+            @logger.warn(progname = 'Comufy::Connector.register_tags') {
               '618 - _ERROR_DOMAIN_APPLICATION_TAG_ALREADY_REGISTERED'
             }
           else
-            @logger.debug(progname = 'Comufy::Connect.register_tags') {
+            @logger.debug(progname = 'Comufy::Connector.register_tags') {
               "UNKNOWN RESPONSE - data = #{data} - message = #{message}."
             }
-            @logger.warn(progname = 'Comufy::Connect.register_tags') {
+            @logger.warn(progname = 'Comufy::Connector.register_tags') {
               "An error occurred when sending #{data}. Comufy returned #{message}. Please get in touch with Comufy if you cannot resolve the problem."
             }
         end
       else
-        @logger.debug(progname = 'Comufy::Connect.register_tags') {
+        @logger.debug(progname = 'Comufy::Connector.register_tags') {
           "Authentication failed - data = #{data}."
         }
-        @logger.warn(progname = 'Comufy::Connect.register_tags') {
+        @logger.warn(progname = 'Comufy::Connector.register_tags') {
           "Authentication failed when sending #{data}. Please get in touch with Comufy if you cannot resolve the problem."
         }
       end
@@ -358,13 +393,13 @@ module Comufy
     def unregister_tag app_name, tag
       return false unless get_access_token
       if app_name.nil? or app_name.empty?
-        @logger.warn(progname = 'Comufy::Connect.unregister_tag') {
+        @logger.warn(progname = 'Comufy::Connector.unregister_tag') {
           'First parameter must be set to your application name.'
         }
         return false
       end
       if tag.nil? or tag.empty?
-        @logger.warn(progname = 'Comufy::Connect.unregister_tag') {
+        @logger.warn(progname = 'Comufy::Connector.unregister_tag') {
           'Second parameter must be set to the tag.'
         }
         return false
@@ -381,48 +416,51 @@ module Comufy
       if message
         case message['cd']
           when 385 then
+            @logger.debug(progname = 'Comufy::Connector.unregister_tag') {
+              "385 - Success! - data = #{data} - message = #{message}."
+            }
             return true
           when 475 then
-            @logger.debug(progname = 'Comufy::Connect.unregister_tag') {
+            @logger.debug(progname = 'Comufy::Connector.unregister_tag') {
               "475 - Invalid parameters provided - data = #{data} - message = #{message}."
             }
-            @logger.warn(progname = 'Comufy::Connect.unregister_tag') {
+            @logger.warn(progname = 'Comufy::Connector.unregister_tag') {
               '475 - Invalid parameters provided'
             }
           when 603 then
-            @logger.debug(progname = 'Comufy::Connect.unregister_tag') {
+            @logger.debug(progname = 'Comufy::Connector.unregister_tag') {
               "603 - _ERROR_DOMAIN_APPLICATION_NAME_NOT_FOUND - data = #{data} - message = #{message}."
             }
-            @logger.warn(progname = 'Comufy::Connect.unregister_tag') {
+            @logger.warn(progname = 'Comufy::Connector.unregister_tag') {
               '603 - _ERROR_DOMAIN_APPLICATION_NAME_NOT_FOUND'
             }
           when 607 then
-            @logger.debug(progname = 'Comufy::Connect.unregister_tag') {
+            @logger.debug(progname = 'Comufy::Connector.unregister_tag') {
               "607 - _ERROR_UNAUTHORISED_ACTION - data = #{data} - message = #{message}."
             }
-            @logger.warn(progname = 'Comufy::Connect.unregister_tag') {
+            @logger.warn(progname = 'Comufy::Connector.unregister_tag') {
               '607 - _ERROR_UNAUTHORISED_ACTION'
             }
           when 617 then
-            @logger.debug(progname = 'Comufy::Connect.unregister_tag') {
+            @logger.debug(progname = 'Comufy::Connector.unregister_tag') {
               "617 - _ERROR_DOMAIN_APPLICATION_TAG_NOT_FOUND - data = #{data} - message = #{message}."
             }
-            @logger.warn(progname = 'Comufy::Connect.unregister_tag') {
+            @logger.warn(progname = 'Comufy::Connector.unregister_tag') {
               '617 - _ERROR_DOMAIN_APPLICATION_TAG_NOT_FOUND'
             }
           else
-            @logger.debug(progname = 'Comufy::Connect.unregister_tag') {
+            @logger.debug(progname = 'Comufy::Connector.unregister_tag') {
               "UNKNOWN RESPONSE - data = #{data} - message = #{message}."
             }
-            @logger.warn(progname = 'Comufy::Connect.unregister_tag') {
+            @logger.warn(progname = 'Comufy::Connector.unregister_tag') {
               "An error occurred when sending #{data}. Comufy returned #{message}. Please get in touch with Comufy if you cannot resolve the problem."
             }
         end
       else
-        @logger.debug(progname = 'Comufy::Connect.unregister_tag') {
+        @logger.debug(progname = 'Comufy::Connector.unregister_tag') {
           "Authentication failed - data = #{data}."
         }
-        @logger.warn(progname = 'Comufy::Connect.unregister_tag') {
+        @logger.warn(progname = 'Comufy::Connector.unregister_tag') {
           "Authentication failed when sending #{data}. Please get in touch with Comufy if you cannot resolve the problem."
         }
       end
@@ -458,25 +496,25 @@ module Comufy
     def send_facebook_message app_name, description, content, uids, opts = {}
       return false unless get_access_token
       if app_name.nil? or app_name.empty? or not content.is_a?(String)
-        @logger.warn(progname = 'Comufy::Connect.send_facebook_message') {
+        @logger.warn(progname = 'Comufy::Connector.send_facebook_message') {
           'First parameter must be set to your application name, as a String.'
         }
         return false
       end
       if description.nil? or description.empty? or not content.is_a?(String)
-        @logger.warn(progname = 'Comufy::Connect.send_facebook_message') {
+        @logger.warn(progname = 'Comufy::Connector.send_facebook_message') {
           'Second parameter must be set to your facebook description, as a String.'
         }
         return false
       end
       if content.nil? or content.empty? or not content.is_a?(String)
-        @logger.warn(progname = 'Comufy::Connect.send_facebook_message') {
+        @logger.warn(progname = 'Comufy::Connector.send_facebook_message') {
           'Third parameter must be sent to your facebook content, as a String.'
         }
         return false
       end
       if uids.nil? or uids.empty? or not uids.is_a?(Array)
-        @logger.warn(progname = 'Comufy::Connect.send_facebook_message') {
+        @logger.warn(progname = 'Comufy::Connector.send_facebook_message') {
           'Fourth parameter must be sent to your facebook uids, as an Array of Strings.'
         }
         return false
@@ -487,25 +525,25 @@ module Comufy
 
       # optional checks
       if opts.has_key?(:filter) and not opts[:filter].is_a?(String)
-        @logger.warn(progname = 'Comufy::Connect.send_facebook_message') {
+        @logger.warn(progname = 'Comufy::Connector.send_facebook_message') {
           'When including "filter", it must be a String.'
         }
         return false
       end
       if opts.has_key?(:delivery_time) and not opts[:delivery_time].is_a?(Integer)
-        @logger.warn(progname = 'Comufy::Connect.send_facebook_message') {
+        @logger.warn(progname = 'Comufy::Connector.send_facebook_message') {
           'When including "delivery_time", it must be an Integer, of unix time in milliseconds.'
         }
         return false
       end
       if opts.has_key?(:shorten_urls) and not %w[ true, false ].include?(opts[:shorten_urls])
-        @logger.warn(progname = 'Comufy::Connect.send_facebook_message') {
+        @logger.warn(progname = 'Comufy::Connector.send_facebook_message') {
           'When including "shorten_urls", it must be an boolean value.'
         }
         return false
       end
       if opts.has_key?(:message_options) and not opts[:message_options].is_a?(Hash)
-        @logger.warn(progname = 'Comufy::Connect.send_facebook_message') {
+        @logger.warn(progname = 'Comufy::Connector.send_facebook_message') {
           'When including "message_options", it must be a Hash.'
         }
         return false
@@ -543,83 +581,86 @@ module Comufy
       if message
         case message['cd']
           when 383 then
+            @logger.debug(progname = 'Comufy::Connector.send_facebook_message') {
+              "383 - Success! - data = #{data} - message = #{message}."
+            }
             return true
           when 416 then
-            @logger.debug(progname = 'Comufy::Connect.send_facebook_message') {
+            @logger.debug(progname = 'Comufy::Connector.send_facebook_message') {
               "416 - _ERROR_MSG_SEND_FAILED - data = #{data} - message = #{message}."
             }
-            @logger.warn(progname = 'Comufy::Connect.send_facebook_message') {
+            @logger.warn(progname = 'Comufy::Connector.send_facebook_message') {
               '416 - _ERROR_MSG_SEND_FAILED'
             }
           when 475 then
-            @logger.debug(progname = 'Comufy::Connect.send_facebook_message') {
+            @logger.debug(progname = 'Comufy::Connector.send_facebook_message') {
               "475 - Invalid parameters provided - data = #{data} - message = #{message}."
             }
-            @logger.warn(progname = 'Comufy::Connect.send_facebook_message') {
+            @logger.warn(progname = 'Comufy::Connector.send_facebook_message') {
               '475 - Invalid parameters provided'
             }
           when 551 then
-            @logger.debug(progname = 'Comufy::Connect.send_facebook_message') {
+            @logger.debug(progname = 'Comufy::Connector.send_facebook_message') {
               "551 _ERROR_TAG_VALUE_NOT_FOUND - data = #{data} - message = #{message}."
             }
-            @logger.warn(progname = 'Comufy::Connect.send_facebook_message') {
+            @logger.warn(progname = 'Comufy::Connector.send_facebook_message') {
               '551 - _ERROR_TAG_VALUE_NOT_FOUND'
             }
           when 603 then
-            @logger.debug(progname = 'Comufy::Connect.send_facebook_message') {
+            @logger.debug(progname = 'Comufy::Connector.send_facebook_message') {
               "603 - _ERROR_DOMAIN_APPLICATION_NAME_NOT_FOUND - data = #{data} - message = #{message}."
             }
-            @logger.warn(progname = 'Comufy::Connect.send_facebook_message') {
+            @logger.warn(progname = 'Comufy::Connector.send_facebook_message') {
               '603 - _ERROR_DOMAIN_APPLICATION_NAME_NOT_FOUND'
             }
           when 607 then
-            @logger.debug(progname = 'Comufy::Connect.send_facebook_message') {
+            @logger.debug(progname = 'Comufy::Connector.send_facebook_message') {
               "607 - _ERROR_UNAUTHORISED_ACTION - data = #{data} - message = #{message}."
             }
-            @logger.warn(progname = 'Comufy::Connect.send_facebook_message') {
+            @logger.warn(progname = 'Comufy::Connector.send_facebook_message') {
               '607 - _ERROR_UNAUTHORISED_ACTION'
             }
           when 617 then
-            @logger.debug(progname = 'Comufy::Connect.send_facebook_message') {
+            @logger.debug(progname = 'Comufy::Connector.send_facebook_message') {
               "617 - _ERROR_DOMAIN_APPLICATION_TAG_NOT_FOUND - data = #{data} - message = #{message}."
             }
-            @logger.warn(progname = 'Comufy::Connect.send_facebook_message') {
+            @logger.warn(progname = 'Comufy::Connector.send_facebook_message') {
               '617 - _ERROR_DOMAIN_APPLICATION_TAG_NOT_FOUND'
             }
           when 648 then
-            @logger.debug(progname = 'Comufy::Connect.send_facebook_message') {
+            @logger.debug(progname = 'Comufy::Connector.send_facebook_message') {
               "648 - _ERROR_FACEBOOK_APPLICATION_USER_NOT_FOUND - data = #{data} - message = #{message}."
             }
-            @logger.warn(progname = 'Comufy::Connect.send_facebook_message') {
+            @logger.warn(progname = 'Comufy::Connector.send_facebook_message') {
               '648 - _ERROR_FACEBOOK_APPLICATION_USER_NOT_FOUND'
             }
           when 673 then
-            @logger.debug(progname = 'Comufy::Connect.send_facebook_message') {
+            @logger.debug(progname = 'Comufy::Connector.send_facebook_message') {
               "673 - Invalid time exception - data = #{data} - message = #{message}."
             }
-            @logger.warn(progname = 'Comufy::Connect.send_facebook_message') {
+            @logger.warn(progname = 'Comufy::Connector.send_facebook_message') {
               '673 - Invalid time exception'
             }
           when 679 then
-            @logger.debug(progname = 'Comufy::Connect.send_facebook_message') {
+            @logger.debug(progname = 'Comufy::Connector.send_facebook_message') {
               "679 - _ERROR_MALFORMED_TARGETING_EXPRESSION - data = #{data} - message = #{message}."
             }
-            @logger.warn(progname = 'Comufy::Connect.send_facebook_message') {
+            @logger.warn(progname = 'Comufy::Connector.send_facebook_message') {
               '679 - _ERROR_MALFORMED_TARGETING_EXPRESSION'
             }
           else
-            @logger.debug(progname = 'Comufy::Connect.send_facebook_message') {
+            @logger.debug(progname = 'Comufy::Connector.send_facebook_message') {
               "UNKNOWN RESPONSE - data = #{data} - message = #{message}."
             }
-            @logger.warn(progname = 'Comufy::Connect.send_facebook_message') {
+            @logger.warn(progname = 'Comufy::Connector.send_facebook_message') {
               "An error occurred when sending #{data}. Comufy returned #{message}. Please get in touch with Comufy if you cannot resolve the problem."
             }
         end
       else
-        @logger.debug(progname = 'Comufy::Connect.send_facebook_message') {
+        @logger.debug(progname = 'Comufy::Connector.send_facebook_message') {
           "Authentication failed - data = #{data}."
         }
-        @logger.warn(progname = 'Comufy::Connect.send_facebook_message') {
+        @logger.warn(progname = 'Comufy::Connector.send_facebook_message') {
           "Authentication failed when sending #{data}. Please get in touch with Comufy if you cannot resolve the problem."
         }
       end
@@ -628,61 +669,64 @@ module Comufy
 
     private
 
-        # Use the configured username and password to get and set the access token and expiry time, if it fails,
-        # it means the user likely has their username/password wrong.
+        # Use the configured user name and password to get and set the access token and expiry time, if it fails,
+        # it means the user likely has their user name/password wrong.
         def authenticate
           data = {
               cd:       131,
-              user:     @config.username,
+              user:     @config.user,
               password: @config.password
           }
 
           message = call_api(data, false)
           case message['cd']
             when 235 then
+              @logger.debug(progname = 'Comufy::Connector.authenticate') {
+                "235 - Success! - data = #{data} - message = #{message}."
+              }
               @config.access_token = message['tokenInfo']['token']
               @config.expiry_time = message['tokenInfo']['expiryTime']
               return true
             when 475 then
-              @logger.debug(progname = 'Comufy::Connect.authenticate') {
+              @logger.debug(progname = 'Comufy::Connector.authenticate') {
                 "475 - Invalid parameters provided. - data = #{data} - message = #{message}."
               }
-              @logger.warn(progname = 'Comufy::Connect.authenticate') {
+              @logger.warn(progname = 'Comufy::Connector.authenticate') {
                 '475 - Invalid parameters provided.'
               }
             when 504 then
-              @logger.debug(progname = 'Comufy::Connect.authenticate') {
+              @logger.debug(progname = 'Comufy::Connector.authenticate') {
                 "504 - FIX. - data = #{data} - message = #{message}."
               }
-              @logger.warn(progname = 'Comufy::Connect.authenticate') {
+              @logger.warn(progname = 'Comufy::Connector.authenticate') {
                 '504 - FIX.'
               }
             when 651 then
-              @logger.debug(progname = 'Comufy::Connect.authenticate') {
-                "651 - Invalid username exception. Check that you are login in using the format user@domain. - data = #{data} - message = #{message}."
+              @logger.debug(progname = 'Comufy::Connector.authenticate') {
+                "651 - Invalid user name exception. Check that you are login in using the format user@domain. - data = #{data} - message = #{message}."
               }
-              @logger.warn(progname = 'Comufy::Connect.authenticate') {
-                '651 - Invalid username exception. Check that you are login in using the format user@domain.'
+              @logger.warn(progname = 'Comufy::Connector.authenticate') {
+                '651 - Invalid user name exception. Check that you are login in using the format user@domain.'
               }
             when 652 then
-              @logger.debug(progname = 'Comufy::Connect.authenticate') {
+              @logger.debug(progname = 'Comufy::Connector.authenticate') {
                 "652 - Invalid password exception. - data = #{data} - message = #{message}."
               }
-              @logger.warn(progname = 'Comufy::Connect.authenticate') {
+              @logger.warn(progname = 'Comufy::Connector.authenticate') {
                 '652 - Invalid password exception.'
               }
             when 682 then
-              @logger.debug(progname = 'Comufy::Connect.authenticate') {
+              @logger.debug(progname = 'Comufy::Connector.authenticate') {
                 "682 - This user is blocked. - data = #{data} - message = #{message}."
               }
-              @logger.warn(progname = 'Comufy::Connect.authenticate') {
+              @logger.warn(progname = 'Comufy::Connector.authenticate') {
                 '682 - This user is blocked.'
               }
             else
-              @logger.debug(progname = 'Comufy::Connect.authenticate') {
+              @logger.debug(progname = 'Comufy::Connector.authenticate') {
                 "UNKNOWN RESPONSE - data = #{data} - message = #{message}."
               }
-              @logger.warn(progname = 'Comufy::Connect.authenticate') {
+              @logger.warn(progname = 'Comufy::Connector.authenticate') {
                 "An error occurred when sending #{data}. Comufy returned #{message}. Please get in touch with Comufy if you cannot resolve the problem."
               }
           end
@@ -701,12 +745,13 @@ module Comufy
             return nil if not get_access_token
             data[:token] = @config.access_token
           end
-          json = CGI::escape(data.to_json)
-          url = URI.parse("#{@config::base_api_url}#{json}")
-          http = Net::HTTP.new(url.host, 443)
-          req = Net::HTTP::Get.new(url.to_s)
+
+          uri = URI.parse(@config::base_api_url)
+          http = Net::HTTP.new(uri.host, uri.port)
           http.use_ssl = true
-          response = http.request(req)
+          request = Net::HTTP::Post.new(uri.path, initheader = { 'Content-Type' => 'application/json' })
+          request.set_form_data({ request: data.to_json })
+          response = http.request(request)
           JSON.parse(response.read_body) if response.message == 'OK'
         end
 

data/lib/comufy/version.rb

@@ -1,3 +1,3 @@
 module Comufy
-  VERSION = "0.0.2b"
+  VERSION = "0.0.2.pre2"
 end

data/lib/comufy.rb

@@ -11,22 +11,13 @@ require 'logger'
 
 module Comufy
 
-  def self.connector params = {}
-    @connector ||= Connector.new(params)
-  end
-
-  def self.new_connector params = {}
-    @connector = Connector.new(params)
-  end
-
-  def version
-    Comufy::VERSION
+  def self.connect params = {}
+    Connector.new(params)
   end
 
   # Based on Rails implementation, ensures all strings are converted
   # into symbols.
   def symbolize_keys hash
-    return hash unless hash.is_a?(Hash)
     hash.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
   end
 end

metadata

@@ -1,19 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: comufy
 version: !ruby/object:Gem::Version
-  version: 0.0.2b
-  prerelease: 5
+  version: 0.0.2.pre2
+  prerelease: 6
 platform: ruby
 authors:
 - plcstevens
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-29 00:00:00.000000000 Z
+date: 2012-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &10377240 !ruby/object:Gem::Requirement
+  requirement: &21817520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '2.5'
   type: :development
   prerelease: false
-  version_requirements: *10377240
+  version_requirements: *21817520
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &10376780 !ruby/object:Gem::Requirement
+  requirement: &21816920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,8 +32,8 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *10376780
-description: ''
+  version_requirements: *21816920
+description: This library can be used with Heroku
 email:
 - philip@tauri-tec.com
 executables: []
@@ -45,6 +45,7 @@ files:
 - README.md
 - Rakefile
 - comufyruby.gemspec
+- example/comufy_example.rb
 - lib/comufy.rb
 - lib/comufy/config.rb
 - lib/comufy/connector.rb
@@ -74,7 +75,8 @@ rubyforge_project:
 rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
-summary: ''
+summary: This library allows customers to interact with the Comufy backend and perform
+  common operations.
 test_files:
 - spec/comufy_spec.rb
 - spec/spec_helper.rb