comufy 0.0.2b

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in comufy.gemspec
+gemspec
+gem 'rake'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 plcstevens
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# Comufyruby
+
+This library allows customers to interact with the Comufy backend and perform common operations.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'comufyruby'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install comufyruby
+
+## Usage
+
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')
+require 'rdoc/task'
+
+Rake::RDocTask.new do |rd|
+  rd.main = "README.md"
+  rd.rdoc_files.include("README.md", "lib/**/*.rb")
+end

data/comufyruby.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'comufy/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "comufy"
+  gem.version       = Comufy::VERSION
+  gem.authors       = %w(plcstevens)
+  gem.email         = %w(philip@tauri-tec.com)
+  gem.description   = %q{}
+  gem.summary       = %q{}
+  gem.homepage      = "https://github.com/plcstevens/comufyruby"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(spec|spec|features)/})
+  gem.require_paths = %w(lib)
+
+  gem.add_development_dependency 'rspec', '~> 2.5'
+  gem.add_development_dependency 'rdoc'
+end

data/lib/comufy/config.rb

@@ -0,0 +1,46 @@
+module Comufy
+  class Config
+    include Comufy
+
+    attr_reader :username, :password, :base_api_url
+    attr_accessor :access_token, :expiry_time
+
+    # Sets the environment settings for Comufy to send and receive messages.
+    # @param [Hash] params - all are optional
+    #   [Object] staging - as long as this is a value other than false/nil it'll change the @base_api_url to 'staging'
+    #   [String] username - sets the username
+    #   [String] password - sets the password
+    #   [Object] no_env - as long as this is a value other than false/nil it'll not use environment values
+    def initialize params = {}
+      params = symbolize_keys(params)
+
+      begin
+        yaml_location = params[:yaml] || File.join(File.dirname(__FILE__), "yaml/config.yaml")
+        yaml = YAML.load_file(yaml_location)
+        yaml = symbolize_keys(yaml)
+      rescue
+        # TODO: should it check the ENV for the username and password?
+        yaml = Hash.new()
+      end
+
+      username = params[:username]
+      password = params[:password]
+      no_env = params[:no_env]
+      staging = params[:staging]
+
+      if (username and not password) or (password and not username)
+        raise "You must supply both a username and password."
+      end
+
+      @username = username || yaml.fetch(:config, {})['username']
+      @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='
+
+    end
+  end
+end

data/lib/comufy/connector.rb

@@ -0,0 +1,729 @@
+module Comufy
+  class Connector
+    include Comufy
+
+    # 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
+    # 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.
+    #
+    # The YAML file provided should appear as:
+    #   config:
+    #     username: username
+    #     password: password
+    #
+    # = Example
+    #
+    #   # use the staging server
+    #   Comufy::Connector.new(staging: true)
+    #
+    #   # 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)
+    #
+    #   # Or you can read in from a YAML file!
+    #
+    #   # tell the connector where to find the yaml file to read
+    #   Comufy::Connector.new(yaml: PATH_TO_YAML_FILE)
+    def initialize params = {}
+      params = symbolize_keys(params)
+      @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
+      # sanitize all output
+      original_formatter = Logger::Formatter.new
+      @logger.formatter = proc { |severity, datetime, progname, msg|
+        original_formatter.call(severity, datetime, progname, msg.dump)
+      }
+    end
+
+    # This API call allows you to register a Facebook user of your application into Comufy’s social CRM.
+    # If this user was already registered with Comufy, their information will be updated.
+    #
+    # * (String) +app_name+ - The application you'll be adding the user to.
+    # * (String) +uid+ - The Facebook ID of the user you'll be adding.
+    # * (Hash) +tags+ - The tags you'll setting for this user.
+    #   * (String) +tag_name+ - Must correspond to one of the tag names of the application.
+    #   * (String) +value+ - Must be the correct value type for that tag.
+    #
+    # = Example
+    #
+    #   Comufy::Connector.store_users(YOUR_APPLICATION_NAME, USER_FACEBOOK_ID, { 'dob' => '1978-10-01 19:50:48' })
+    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') {
+          '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') {
+          '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') {
+          'Third parameter must be a hash of tag information for this uid.'
+        }
+        return false
+      end
+
+      data = {
+          #token:           @config.access_token,
+          cd:              '88',
+          applicationName: app_name,
+          accounts:        [{
+                                account: { fbId: uid },
+                                tags:    tags
+                            }]
+      }
+
+      message = call_api(data)
+      if message
+        case message['cd']
+          when 388 then
+            return true
+          when 475 then
+            @logger.debug(progname = 'Comufy::Connect.store_user') {
+              "475 - Invalid parameter provided. - data = #{data} - message = #{message}."
+            }
+            @logger.warn(progname = 'Comufy::Connect.store_user') {
+              '475 - Invalid parameter provided.'
+            }
+          when 617 then
+            @logger.debug(progname = 'Comufy::Connect.store_user') {
+              "617 - Some of the tags passed are not registered. - data = #{data} - message = #{message}."
+            }
+            @logger.warn(progname = 'Comufy::Connect.store_user') {
+              '617 - Some of the tags passed are not registered.'
+            }
+          when 632 then
+            @logger.debug(progname = 'Comufy::Connect.store_user') {
+              "632 - _ERROR_FACEBOOK_PAGE_NOT_FOUND - data = #{data} - message = #{message}."
+            }
+            @logger.warn(progname = 'Comufy::Connect.store_user') {
+              '632 - _ERROR_FACEBOOK_PAGE_NOT_FOUND'
+            }
+          else
+            @logger.debug(progname = 'Comufy::Connect.store_user') {
+              "UNKNOWN RESPONSE - data = #{data} - message = #{message}."
+            }
+            @logger.warn(progname = 'Comufy::Connect.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') {
+          "Authentication failed - data = #{data}."
+        }
+        @logger.warn(progname = 'Comufy::Connect.store_user') {
+          "Authentication failed when sending #{data}. Please get in touch with Comufy if you cannot resolve the problem."
+        }
+      end
+      false
+    end
+
+    # TODO: IMPLEMENT METHOD
+    def remove_user app_name, uid # :nodoc:
+      return false unless get_access_token
+      @logger.debug(progname = 'Comufy::Connect.remove_user') {
+        'METHOD_NOT_IMPLEMENTED'
+      }
+      @logger.warn(progname = 'Comufy::Connect.remove_user') {
+          'METHOD_NOT_IMPLEMENTED'
+      }
+      app_name
+      uid
+      false
+    end
+
+    #
+    # This API call allows you to register multiple Facebook users of your application into Comufy’s social CRM.
+    # If these users were already registered into Comufy, their information will be updated.
+    #
+    # * (String) +app_name+ - The application you wish to store these users with.
+    # * (Hash) +uid_tags+ - The users you wish to add with their corresponding tag data.
+    #   * (String) +uid+ - The key is the Facebook ID of the user.
+    #   * (Hash) +tags+ - The value is the tags of data to apply for that user.
+    #
+    # = Example
+    #
+    #   Comufy::Connector.store_users(
+    #     YOUR_APPLICATION_NAME,
+    #     { USER_ID => { 'dob' => '1978-10-01 19:50:48' }, OTHER_USER_ID => { 'dob' => '1978-10-01 19:50:48'}}
+    #   )
+    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') {
+          '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') {
+          'Second parameter must be a hash where a key is a Facebook user ID and its value a hash of tags.'
+        }
+        return false
+      end
+
+      data = {
+          #token:           @config.access_token,
+          cd:              '88',
+          applicationName: app_name,
+          accounts:        uid_tags.map { |uid, tags| Hash[:account, { fbId: uid }, :tags, tags] }
+      }
+
+      message = call_api(data)
+      if message
+        case message['cd']
+          when 388 then
+            return true
+          when 475 then
+            @logger.debug(progname = 'Comufy::Connect.store_users') {
+              "603 - Invalid parameter provided. - data = #{data} - message = #{message}."
+            }
+            @logger.warn(progname = 'Comufy::Connect.store_users') {
+              '475 - Invalid parameter provided.'
+            }
+          when 617 then
+            @logger.debug(progname = 'Comufy::Connect.store_users') {
+              "617 - Some of the tags passed are not registered. - data = #{data} - message = #{message}."
+            }
+            @logger.warn(progname = 'Comufy::Connect.store_users') {
+              '617 - Some of the tags passed are not registered.'
+            }
+          when 632 then
+            @logger.debug(progname = 'Comufy::Connect.store_users') {
+              "632 - _ERROR_FACEBOOK_PAGE_NOT_FOUND - data = #{data} - message = #{message}."
+            }
+            @logger.warn(progname = 'Comufy::Connect.store_users') {
+              '632 - _ERROR_FACEBOOK_PAGE_NOT_FOUND'
+            }
+          else
+            @logger.debug(progname = 'Comufy::Connect.store_users') {
+              "UNKNOWN RESPONSE - data = #{data} - message = #{message}."
+            }
+            @logger.warn(progname = 'Comufy::Connect.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') {
+          "Authentication failed - data = #{data}."
+        }
+        @logger.warn(progname = 'Comufy::Connect.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.
+    # * (Array) +tags+ - The tags you wish to register, each of which must be a (Hash) containing two keys.
+    #   * (String) +name+ - The name for the tag.
+    #   * (String) +type+ - Must be one of the following: STRING, DATE, GENDER, INT, FLOAT.
+    #
+    # = Example
+    #   Comufy::Connector.register_tags(
+    #     YOUR_APPLICATION_NAME,
+    #     [{
+    #       'name' => 'dob',
+    #       'type' => 'DATE'
+    #     },
+    #     {
+    #       'name' => 'height',
+    #       'type' => 'FLOAT'
+    #     }]
+    #   )
+    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') {
+          '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') {
+          '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".'
+            }
+            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.'
+            }
+            return false
+          end
+        end
+      end
+
+      data = {
+          #token:           @config.access_token,
+          tags:            tags,
+          cd:              86,
+          applicationName: app_name
+      }
+
+      message = call_api(data)
+      if message
+        case message['cd']
+          when 386 then
+            return true
+          when 475 then
+            @logger.debug(progname = 'Comufy::Connect.register_tags') {
+              "475 - Invalid parameters provided - data = #{data} - message = #{message}."
+            }
+            @logger.warn(progname = 'Comufy::Connect.register_tags') {
+              '475 - Invalid parameters provided'
+            }
+          when 603 then
+            @logger.debug(progname = 'Comufy::Connect.register_tags') {
+              "603 - _ERROR_DOMAIN_APPLICATION_NAME_NOT_FOUND - data = #{data} - message = #{message}."
+            }
+            @logger.warn(progname = 'Comufy::Connect.register_tags') {
+              '603 - _ERROR_DOMAIN_APPLICATION_NAME_NOT_FOUND'
+            }
+          when 607 then
+            @logger.debug(progname = 'Comufy::Connect.register_tags') {
+              "607 - _ERROR_UNAUTHORISED_ACTION - data = #{data} - message = #{message}."
+            }
+            @logger.warn(progname = 'Comufy::Connect.register_tags') {
+              '607 - _ERROR_UNAUTHORISED_ACTION'
+            }
+          when 618 then
+            @logger.debug(progname = 'Comufy::Connect.register_tags') {
+              "618 - _ERROR_DOMAIN_APPLICATION_TAG_ALREADY_REGISTERED - data = #{data} - message = #{message}."
+            }
+            @logger.warn(progname = 'Comufy::Connect.register_tags') {
+              '618 - _ERROR_DOMAIN_APPLICATION_TAG_ALREADY_REGISTERED'
+            }
+          else
+            @logger.debug(progname = 'Comufy::Connect.register_tags') {
+              "UNKNOWN RESPONSE - data = #{data} - message = #{message}."
+            }
+            @logger.warn(progname = 'Comufy::Connect.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') {
+          "Authentication failed - data = #{data}."
+        }
+        @logger.warn(progname = 'Comufy::Connect.register_tags') {
+          "Authentication failed when sending #{data}. Please get in touch with Comufy if you cannot resolve the problem."
+        }
+      end
+      false
+    end
+
+    #
+    # This API call will unregister an existing application tag. All data associated with the tag will be lost.
+    #
+    # * (String) +app_name+ - The application on which to remove the tag.
+    # * (String) +tag+ - The tag to remove from the user.
+    #
+    # = Example
+    #   Comufy::Connector.unregister_tag(YOUR_APPLICATION_NAME, 'dob')
+    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') {
+          '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') {
+          'Second parameter must be set to the tag.'
+        }
+        return false
+      end
+
+      data = {
+          #token:           @config.access_token,
+          tag:             tag,
+          cd:              85,
+          applicationName: app_name
+      }
+
+      message = call_api(data)
+      if message
+        case message['cd']
+          when 385 then
+            return true
+          when 475 then
+            @logger.debug(progname = 'Comufy::Connect.unregister_tag') {
+              "475 - Invalid parameters provided - data = #{data} - message = #{message}."
+            }
+            @logger.warn(progname = 'Comufy::Connect.unregister_tag') {
+              '475 - Invalid parameters provided'
+            }
+          when 603 then
+            @logger.debug(progname = 'Comufy::Connect.unregister_tag') {
+              "603 - _ERROR_DOMAIN_APPLICATION_NAME_NOT_FOUND - data = #{data} - message = #{message}."
+            }
+            @logger.warn(progname = 'Comufy::Connect.unregister_tag') {
+              '603 - _ERROR_DOMAIN_APPLICATION_NAME_NOT_FOUND'
+            }
+          when 607 then
+            @logger.debug(progname = 'Comufy::Connect.unregister_tag') {
+              "607 - _ERROR_UNAUTHORISED_ACTION - data = #{data} - message = #{message}."
+            }
+            @logger.warn(progname = 'Comufy::Connect.unregister_tag') {
+              '607 - _ERROR_UNAUTHORISED_ACTION'
+            }
+          when 617 then
+            @logger.debug(progname = 'Comufy::Connect.unregister_tag') {
+              "617 - _ERROR_DOMAIN_APPLICATION_TAG_NOT_FOUND - data = #{data} - message = #{message}."
+            }
+            @logger.warn(progname = 'Comufy::Connect.unregister_tag') {
+              '617 - _ERROR_DOMAIN_APPLICATION_TAG_NOT_FOUND'
+            }
+          else
+            @logger.debug(progname = 'Comufy::Connect.unregister_tag') {
+              "UNKNOWN RESPONSE - data = #{data} - message = #{message}."
+            }
+            @logger.warn(progname = 'Comufy::Connect.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') {
+          "Authentication failed - data = #{data}."
+        }
+        @logger.warn(progname = 'Comufy::Connect.unregister_tag') {
+          "Authentication failed when sending #{data}. Please get in touch with Comufy if you cannot resolve the problem."
+        }
+      end
+      false
+    end
+
+    # Sends a message with the description and content to the facebook id or id's specified, allowing multiple
+    # options to be set concerning the privacy, and content of the message.
+    #
+    # * (String) +app_name+ - The application through the message is sent.
+    # * (String) +description+ - Description of the message. Useful to aggregate data in the Comufy dashboard. e.g. "Welcome".
+    # * (String) +content+ - The text message content.
+    # * (Array) +uids+ - The Facebook IDs of the users to send the message to.
+    # * (Hash) +opts+ - Optional settings you can pass.
+    #   * (Integer) +delivery_time+ - The scheduled time of delivery defaults to now. (Unix millisecond timestamps)
+    #   * (Boolean) +shorten_urls+ - UNTRACKED if false, otherwise defaults to Comufy TRACKED
+    #   * (String) +filter+ - filtering condition in CFL.
+    #   * (Hash) +message_options+ - options to set for the message especially.
+    #     * (String) +name+ - facebook message name.
+    #     * (String) +link+ - Facebook message link.
+    #     * (String) +caption+ - facebook message caption.
+    #     * (String) +description+ - description of the message.
+    #     * (String) +picture+ - URL of the image that should appear on the image section of the message.
+    #     * (Boolean) +privacy+ -  whether the message should be sent private or not.
+    #
+    # = Example
+    #    Comufy::Connector.send_facebook_message(
+    #      YOUR_APPLICATION_NAME, DESCRIPTION, CONTENT_GOES_HERE, %w(ID_ONE ID_TWO),
+    #      message_options: {
+    #        private: true, link: 'www.example.com', name: 'test', description: 'description'
+    #      }
+    #    )
+    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') {
+          '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') {
+          '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') {
+          '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') {
+          'Fourth parameter must be sent to your facebook uids, as an Array of Strings.'
+        }
+        return false
+      end
+
+      # symbolize the keys!
+      opts = symbolize_keys(opts)
+
+      # optional checks
+      if opts.has_key?(:filter) and not opts[:filter].is_a?(String)
+        @logger.warn(progname = 'Comufy::Connect.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') {
+          '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') {
+          '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') {
+          'When including "message_options", it must be a Hash.'
+        }
+        return false
+      end
+
+      facebook_ids = "FACEBOOK_ID=\"#{uids.join('\" OR FACEBOOK_ID=\"')}\""
+
+      filter = opts[:filter] || String.new()
+      delivery_time = opts[:delivery_time]
+      shorten_urls =  opts.has_key?(:shorten_urls) ? opts[:shorten_urls] : true
+      options = opts[:message_options]
+
+      data = {
+          cd:              83,
+          applicationName: app_name,
+          description:     description,
+          content:         content,
+          filter:          "#{facebook_ids} #{filter}"
+      }
+
+      data[:deliveryTime] = delivery_time if delivery_time
+      data[:trackingMode] = "UNTRACKED" unless shorten_urls
+      data[:facebookTargetingMode] = "NOTIFICATION"
+
+      if options
+        data[:fbMessagePrivacyMode] = options[:private] ? "PRIVATE" : "PUBLIC" if options.has_key?(:private)
+        data[:fbMessageCaption]     = options[:caption]                        if options.has_key?(:caption)
+        data[:fbMessageLink]        = options[:link]                           if options.has_key?(:link)
+        data[:fbMessageName]        = options[:name]                           if options.has_key?(:name)
+        data[:fbMessageDescription] = options[:description]                    if options.has_key?(:description)
+        data[:fbMessagePictureUrl]  = options[:picture]                        if options.has_key?(:picture)
+      end
+
+      message = call_api(data)
+      if message
+        case message['cd']
+          when 383 then
+            return true
+          when 416 then
+            @logger.debug(progname = 'Comufy::Connect.send_facebook_message') {
+              "416 - _ERROR_MSG_SEND_FAILED - data = #{data} - message = #{message}."
+            }
+            @logger.warn(progname = 'Comufy::Connect.send_facebook_message') {
+              '416 - _ERROR_MSG_SEND_FAILED'
+            }
+          when 475 then
+            @logger.debug(progname = 'Comufy::Connect.send_facebook_message') {
+              "475 - Invalid parameters provided - data = #{data} - message = #{message}."
+            }
+            @logger.warn(progname = 'Comufy::Connect.send_facebook_message') {
+              '475 - Invalid parameters provided'
+            }
+          when 551 then
+            @logger.debug(progname = 'Comufy::Connect.send_facebook_message') {
+              "551 _ERROR_TAG_VALUE_NOT_FOUND - data = #{data} - message = #{message}."
+            }
+            @logger.warn(progname = 'Comufy::Connect.send_facebook_message') {
+              '551 - _ERROR_TAG_VALUE_NOT_FOUND'
+            }
+          when 603 then
+            @logger.debug(progname = 'Comufy::Connect.send_facebook_message') {
+              "603 - _ERROR_DOMAIN_APPLICATION_NAME_NOT_FOUND - data = #{data} - message = #{message}."
+            }
+            @logger.warn(progname = 'Comufy::Connect.send_facebook_message') {
+              '603 - _ERROR_DOMAIN_APPLICATION_NAME_NOT_FOUND'
+            }
+          when 607 then
+            @logger.debug(progname = 'Comufy::Connect.send_facebook_message') {
+              "607 - _ERROR_UNAUTHORISED_ACTION - data = #{data} - message = #{message}."
+            }
+            @logger.warn(progname = 'Comufy::Connect.send_facebook_message') {
+              '607 - _ERROR_UNAUTHORISED_ACTION'
+            }
+          when 617 then
+            @logger.debug(progname = 'Comufy::Connect.send_facebook_message') {
+              "617 - _ERROR_DOMAIN_APPLICATION_TAG_NOT_FOUND - data = #{data} - message = #{message}."
+            }
+            @logger.warn(progname = 'Comufy::Connect.send_facebook_message') {
+              '617 - _ERROR_DOMAIN_APPLICATION_TAG_NOT_FOUND'
+            }
+          when 648 then
+            @logger.debug(progname = 'Comufy::Connect.send_facebook_message') {
+              "648 - _ERROR_FACEBOOK_APPLICATION_USER_NOT_FOUND - data = #{data} - message = #{message}."
+            }
+            @logger.warn(progname = 'Comufy::Connect.send_facebook_message') {
+              '648 - _ERROR_FACEBOOK_APPLICATION_USER_NOT_FOUND'
+            }
+          when 673 then
+            @logger.debug(progname = 'Comufy::Connect.send_facebook_message') {
+              "673 - Invalid time exception - data = #{data} - message = #{message}."
+            }
+            @logger.warn(progname = 'Comufy::Connect.send_facebook_message') {
+              '673 - Invalid time exception'
+            }
+          when 679 then
+            @logger.debug(progname = 'Comufy::Connect.send_facebook_message') {
+              "679 - _ERROR_MALFORMED_TARGETING_EXPRESSION - data = #{data} - message = #{message}."
+            }
+            @logger.warn(progname = 'Comufy::Connect.send_facebook_message') {
+              '679 - _ERROR_MALFORMED_TARGETING_EXPRESSION'
+            }
+          else
+            @logger.debug(progname = 'Comufy::Connect.send_facebook_message') {
+              "UNKNOWN RESPONSE - data = #{data} - message = #{message}."
+            }
+            @logger.warn(progname = 'Comufy::Connect.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') {
+          "Authentication failed - data = #{data}."
+        }
+        @logger.warn(progname = 'Comufy::Connect.send_facebook_message') {
+          "Authentication failed when sending #{data}. Please get in touch with Comufy if you cannot resolve the problem."
+        }
+      end
+      false
+    end
+
+    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.
+        def authenticate
+          data = {
+              cd:       131,
+              user:     @config.username,
+              password: @config.password
+          }
+
+          message = call_api(data, false)
+          case message['cd']
+            when 235 then
+              @config.access_token = message['tokenInfo']['token']
+              @config.expiry_time = message['tokenInfo']['expiryTime']
+              return true
+            when 475 then
+              @logger.debug(progname = 'Comufy::Connect.authenticate') {
+                "475 - Invalid parameters provided. - data = #{data} - message = #{message}."
+              }
+              @logger.warn(progname = 'Comufy::Connect.authenticate') {
+                '475 - Invalid parameters provided.'
+              }
+            when 504 then
+              @logger.debug(progname = 'Comufy::Connect.authenticate') {
+                "504 - FIX. - data = #{data} - message = #{message}."
+              }
+              @logger.warn(progname = 'Comufy::Connect.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.warn(progname = 'Comufy::Connect.authenticate') {
+                '651 - Invalid username exception. Check that you are login in using the format user@domain.'
+              }
+            when 652 then
+              @logger.debug(progname = 'Comufy::Connect.authenticate') {
+                "652 - Invalid password exception. - data = #{data} - message = #{message}."
+              }
+              @logger.warn(progname = 'Comufy::Connect.authenticate') {
+                '652 - Invalid password exception.'
+              }
+            when 682 then
+              @logger.debug(progname = 'Comufy::Connect.authenticate') {
+                "682 - This user is blocked. - data = #{data} - message = #{message}."
+              }
+              @logger.warn(progname = 'Comufy::Connect.authenticate') {
+                '682 - This user is blocked.'
+              }
+            else
+              @logger.debug(progname = 'Comufy::Connect.authenticate') {
+                "UNKNOWN RESPONSE - data = #{data} - message = #{message}."
+              }
+              @logger.warn(progname = 'Comufy::Connect.authenticate') {
+                "An error occurred when sending #{data}. Comufy returned #{message}. Please get in touch with Comufy if you cannot resolve the problem."
+              }
+          end
+          # an issue occurred, reset the access token and expiry time.
+          @config.access_token = nil
+          @config.expiry_time = nil
+          false
+        end
+
+        # Calls the Comufy backed with the provided set of parameters, which the system will expect
+        #
+        # * (Array) +params+ - Data to be passed to the server.
+        # * (Boolean) +add_access_token+ - (Optional) Whether or not the access token should be provided.
+        def call_api data, add_access_token=true
+          if add_access_token
+            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)
+          http.use_ssl = true
+          response = http.request(req)
+          JSON.parse(response.read_body) if response.message == 'OK'
+        end
+
+        # Checks that the token is not expired, and if expired, force an authentication.
+        def get_access_token
+          return authenticate if has_token_expired
+          true
+        end
+
+        # If the expiry time is set, and hasn't been reached, return false, otherwise
+        # reset the access_token and expiry time,
+        def has_token_expired
+          return false if @config.expiry_time != nil and Time.at(@config.expiry_time) > Time.now
+          @config.expiry_time = nil
+          @config.access_token = nil
+          true
+        end
+
+  end
+end

data/lib/comufy/version.rb

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

data/lib/comufy.rb

@@ -0,0 +1,32 @@
+require "comufy/version"
+require "comufy/config"
+require "comufy/connector"
+
+require 'yaml'
+require 'json'
+require 'net/http'
+require 'net/https'
+require 'cgi'
+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
+  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

data/spec/comufy_spec.rb

@@ -0,0 +1,18 @@
+require "spec_helper"
+
+describe Comufy do
+
+  it "should return a Comufy::Connector object" do
+    Comufy.connector.class.should == Comufy::Connector
+  end
+
+  it "should return same object when calling Comufy.connector twice" do
+    object = Comufy.connector
+    object.should == Comufy.connector
+  end
+
+  it "should create a new different object when calling Comufy.new_connector" do
+    object = Comufy.connector
+    object.should_not == Comufy.new_connector
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require "rspec"
+require "comufy"
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.formatter     = 'documentation'
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: comufy
+version: !ruby/object:Gem::Version
+  version: 0.0.2b
+  prerelease: 5
+platform: ruby
+authors:
+- plcstevens
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &10377240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: *10377240
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &10376780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *10376780
+description: ''
+email:
+- philip@tauri-tec.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- comufyruby.gemspec
+- lib/comufy.rb
+- lib/comufy/config.rb
+- lib/comufy/connector.rb
+- lib/comufy/version.rb
+- spec/comufy_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/plcstevens/comufyruby
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: ''
+test_files:
+- spec/comufy_spec.rb
+- spec/spec_helper.rb