comufyrails 0.0.2 → 0.1.0

data/.gitignore

@@ -15,3 +15,5 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.idea/
+html/

data/Gemfile

@@ -4,3 +4,5 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'rails'
+gem 'em-synchrony'
+gem 'em-http-request'

data/README.md

@@ -1,24 +1,112 @@
 # Comufyrails
 
-TODO: Write a gem description
+This gem allows [Ruby on Rails](http://rubyonrails.org/) projects to connect with the
+[Comufy service](http://www.comufy.com/). It uses asynchronous calls and separate rake tasks to communicate with
+the Comufy API, allowing you to create, update your list of users as well as registering new tags and send
+messages to your users.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add any of the lines to your application's Gemfile:
 
     gem 'comufyrails'
+    gem 'comufyrails', :git => "git://github.com/plcstevens/comufyrails.git"
+    gem 'comufyrails', :path => "/path/to/comufyrails/directory"
 
 And then execute:
 
     $ bundle
 
-Or install it yourself as:
+Or install it yourself:
 
     $ gem install comufyrails
 
+
+## Web servers
+
+As this gem uses EventMachine to perform asynchronous methods you need to use a web server that supports EventMachine,
+such as [thin](http://code.macournoyer.com/thin/).
+
+## Configuration
+
+The gem requires configuration before being used. To get these values you must create an account with Comufy through
+our Heroku service, or by yourself.
+
+On Heroku you should add the Comufy add-on and follow the configuration steps it gives you. This will automatically
+set the environment variables for your Comufy account that this gem will use. If you are not using our Heroku
+service you will need to find another way to get these values, listed below.
+
+If you are using this on your local development machine or elsewhere you have two ways to configure this gem. You
+can get these values by using this heroku command below and looking for all values starting with 'COMUFY_'.
+
+    heroku config
+
+You can set the values in your config/environments/*.rb in the same manner you set rails-specific values.
+
+```ruby
+config.comufy_rails.app_name      = 'YOUR_APPLICATION_NAME'
+config.comufy_rails.access_token  = 'YOUR_ACCESS_TOKEN'
+config.comufy_rails.url  = 'COMUFY'
+```
+
+Alternatively you can set these in your environment/path.
+
+```
+COMUFY_APP_NAME     - Application name on Comufy, defaults to your Ruby on Rails application name.
+COMUFY_TOKEN        - Token given to you by our Comufy Heroku service or from Comufy directly.
+COMUFY_URL - Full HTTP address to connect to, defaults to our service.
+```
+
 ## Usage
 
-TODO: Write usage instructions here
+In its current iteration you can use this gem to send information to Comufy, allowing you to add users, update data
+on the users and send messages/notifications to your users via your own service.
+
+If you have your own user database, and wish to keep the Comufy database in sync with it, you can use the observer
+behaviour for your model and asynchronously send the data to Comufy.
+
+```ruby
+class UserObserver < ActiveRecord::Observer
+
+  def after_save(user)
+    data = { dob: user.dob.to_comufy_time, fact: user.fact }
+    Comufyrails::Connection.store_user(user.facebook_id, data)
+  end
+end
+```
+
+Or you can place the code in your controllers. As this method is asynchronous it will not block and affect
+performance. It should be noted that these methods return their results to the logs.
+
+```ruby
+  # POST /users
+  # POST /users.json
+  def create
+    @user = User.new(params[:user])
+
+    respond_to do |format|
+      if @user.save
+        Comufyrails::Connection.store_user(user.facebook_id, { dob: user.dob.to_comufy_time, fact: user.fact })
+        format.html { redirect_to @user, notice: 'User was successfully created.' }
+        format.json { render json: @user, status: :created, location: @user }
+      else
+        format.html { render action: "new" }
+        format.json { render json: @user.errors, status: :unprocessable_entity }
+      end
+    end
+  end
+```
+
+There are also a number of methods that are added to your rake environment, for one-time actions. These include
+the ability to add/remove tags for users of your applications.
+
+```bash
+$ bundle exec rake comufy:tag["DOB", "DATE"]
+```
+
+This will run a blocking call to register this tag with your application, informing you if it was successful or not.
+It will use the configuration exactly as your Rails application will, so if you need to run it as production, you
+merely have to add RAILS_ENV=production or -e production.
 
 ## Contributing
 

data/Rakefile

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

data/comufyrails.gemspec

@@ -18,6 +18,8 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
 
   gem.add_dependency('activesupport')
+  gem.add_dependency('em-synchrony')
+  gem.add_dependency('em-http-request')
 
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rspec'

data/lib/comufyrails.rb

@@ -1,20 +1,37 @@
 require 'rails'
 
-require "comufyrails/version"
+require "comufyrails/core_ext"
 require "comufyrails/connection"
+require "comufyrails/constants"
 require 'comufyrails/railtie' if defined?(Rails)
+require "comufyrails/version"
 
 module Comufyrails
 
+  # Contains the list of constant variables that will be used throughout this gem.
   class Config
-    attr_accessor :app_name, :username, :password, :access_token, :expiry_time, :base_api_url
+    # Application name on Comufy, and on Facebook.
+    attr_accessor :app_name
+    # Access token to access your Applications on Comufy.
+    attr_accessor :access_token
+    # Expiry time of the AccessToken.
+    attr_accessor :expiry_time
+    # The URL of the Comufy service to connect to.
+    attr_accessor :url
   end
 
-  def self.config
-    @@config ||= Config.new
-  end
+  class << self
+    # Comufyrails logger (usually uses the Rails.logger)
+    attr_accessor :logger
+
+    # define as a Config object unless defined
+    def config
+      @@config ||= Config.new
+    end
 
-  def self.configure
-    yield self.config
+    # yield the Comufyrails config class variable
+    def configure
+      yield self.config
+    end
   end
 end

data/lib/comufyrails/connection.rb

@@ -1,10 +1,262 @@
+require "em-synchrony"
+require "em-synchrony/em-http"
 
+# This module contains asynchronous methods for contacting the +comufy.url+ specified in +Config+.
+# It uses +em-synchrony+ and +EventMachine+ to achieve this, and therefore to be run asynchronously you
+# must use a web server that supports these such as +thin+.
+#
+# Methods to store users or send messages all return their results to logs, as they do not provide any information
+# back to the user.
+#
+# Requests for users and tags can return information and will yield to a block if provided, otherwise they will
+# also print to the log. This is often useful for debugging, but in practise you should provide these with a block.
 module Comufyrails::Connection
 
-  # aim of this module is to will be to allow sync/async connections to be sent to our heroku servers
-  # to be processed and then returned (or the error message returned)
+  class IllegalKeyTypeError < StandardError; end
+  class IllegalValueTypeError < StandardError; end
+
+  class << self
+
+    # Shortened method name for storing a user, or users in your Application.
+    # Please see +store_users+ for details.
+    def store(uids, tags) self.store_user(uids, tags) 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) +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
+    #
+    #   Comufyrails::Connection.store_user USER_FACEBOOK_ID, { dob: '1978-10-01 19:50:48' }
+    def store_user(uids, tags)
+      uids = [uids] unless uids.is_a? Array
+      tags = [tags] unless tags.is_a? Array
+      self.store_users(uids, tags)
+    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.
+    #
+    # Please note that you can provide a single String or Integer for uids and one +tag+ if you wish.
+    #
+    # * (Array) +uids+ - A list of (String/Integer) user ids you wish to add/update.
+    # * (Array) +tags+ - A list of hashes for each of the users.
+    #   * (Hash) +tag+
+    #     * (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
+    #
+    #   Comufyrails::Connection.store_users(
+    #     [ USER_ID, USER_ID_2 ],
+    #     [ { 'dob' => '1978-10-01 19:50:48' }, { 'dob' => '1978-10-01 19:50:48'}]
+    #   )
+    def store_users(uids, tags)
+      raise ArgumentError, "uids must be an Array." unless uids.is_a? Array
+      raise ArgumentError, "tags must be an Array." unless tags.is_a? Array
+
+      # Ensure the tags are valid
+      tags.each(&:symbolize_keys!)
+      zipped = uids.zip(tags)
+
+      data = {
+          cd:              '88',
+          token:           Comufyrails.config.access_token,
+          applicationName: Comufyrails.config.app_name,
+          accounts:        zipped.map { |uid, tagged | Hash[:account, { fbId: uid.to_s }, :tags, tagged] }
+      }
+      EM.synchrony do
+        http = EventMachine::HttpRequest.new(Comufyrails.config.url).post(
+            :body => { request: data.to_json }, :initheader => { 'Content-Type' => 'application/json' })
+        if http.response_header.status == 200
+          message = JSON.parse(http.response)
+          case message["cd"]
+            when 388 then
+              p "388 - Success! - data = #{data} - message = #{message}."
+            when 475 then
+              p "475 - Invalid parameter provided. - data = #{data} - message = #{message}."
+            when 617 then
+              p "617 - Some of the tags passed are not registered. - data = #{data} - message = #{message}."
+            when 632 then
+              p "632 - _ERROR_FACEBOOK_PAGE_NOT_FOUND - data = #{data} - message = #{message}."
+            else
+              p "UNKNOWN RESPONSE - data = #{data} - message = #{message}."
+          end
+        else
+          p "Server responded with #{http.response_header}."
+        end
+      end
+    end
+
+    # Shorthand method for sending messages to the selected uids. See +send_facebook_message+ for more information.
+    def message(desc, content, uids, opts = {}) self.send_facebook_message(desc, content, uids, opts) 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) +description+ - Description of the message. Useful to aggregate data in the Comufy dashboard.
+    # * (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
+    #    Comufyrails::Connection.send_facebook_message(
+    #      DESCRIPTION, CONTENT_GOES_HERE, UIDS,
+    #      message_options: {
+    #        private: true, link: 'www.example.com', name: 'test', description: 'description'
+    #      }
+    #    )
+    def send_facebook_message(description, content, uids, opts = {})
+      raise ArgumentError, "Description must be a String."           unless description.is_a? String
+      raise ArgumentError, "Content must be a String."               unless content.is_a? String
+      raise ArgumentError, "Uids must be an Array."                  unless uids.is_a? Array
+      raise ArgumentError, "Opts must be a Hash if you include it."  unless opts.is_a? Hash
+
+      opts.symbolize_keys!
+
+      facebook_ids  = "FACEBOOK.ID=\"#{uids.join('\" OR FACEBOOK.ID=\"')}\""
+      filter        = opts[:filter] || ""
+      delivery_time = opts[:delivery_time]
+      shorten_urls  = opts.has_key?(:shorten_urls) ? opts[:shorten_urls] : true
+      options       = opts[:message_options]
+
+      data = {
+          cd:              83,
+          token:           Comufyrails.config.access_token,
+          applicationName: Comufyrails.config.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
+
+      EM.synchrony do
+        http = EventMachine::HttpRequest.new(Comufyrails.config.url).post(
+            :body => { request: data.to_json }, :initheader => { 'Content-Type' => 'application/json' })
+        if http.response_header.status == 200
+          message = JSON.parse(http.response)
+          case message["cd"]
+            when 383 then
+              p "383 - Success! - data = #{data} - message = #{message}."
+            when 416 then
+              p "416 - _ERROR_MSG_SEND_FAILED - data = #{data} - message = #{message}."
+            when 475 then
+              p "475 - Invalid parameters provided - data = #{data} - message = #{message}."
+            when 551 then
+              p "551 _ERROR_TAG_VALUE_NOT_FOUND - data = #{data} - message = #{message}."
+            when 603 then
+              p "603 - _ERROR_DOMAIN_APPLICATION_NAME_NOT_FOUND - data = #{data} - message = #{message}."
+            when 607 then
+              p "607 - _ERROR_UNAUTHORISED_ACTION - data = #{data} - message = #{message}."
+            when 617 then
+              p "617 - _ERROR_DOMAIN_APPLICATION_TAG_NOT_FOUND - data = #{data} - message = #{message}."
+            when 648 then
+              p "648 - _ERROR_FACEBOOK_APPLICATION_USER_NOT_FOUND - data = #{data} - message = #{message}."
+            when 673 then
+              p "673 - Invalid time exception - data = #{data} - message = #{message}."
+            when 679 then
+              p "679 - _ERROR_MALFORMED_TARGETING_EXPRESSION - data = #{data} - message = #{message}."
+            else
+              p "UNKNOWN RESPONSE - data = #{data} - message = #{message}."
+          end
+        else
+          p "Server responded with #{http.response_header}."
+        end
+      end
+    end
+
+    # Provides a list of all tags for this application. If you provide a block it will yield the response,
+    # otherwise it will be sent the log.
+    def tags
+      data = {
+          cd:               101,
+          token:            Comufyrails.config.access_token,
+          applicationName:  Comufyrails.config.app_name
+      }
+
+      EM.synchrony do
+        http = EventMachine::HttpRequest.new(Comufyrails.config.url).post(
+            :body => { request: data.to_json }, :initheader => { 'Content-Type' => 'application/json' })
+        if http.response_header.status == 200
+          message = JSON.parse(http.response)
+          if block_given?
+            yield message
+          else
+            case message["cd"]
+              when 219 then
+                p "219 - Success! - data = #{data} - message = #{message}."
+              else
+                p "UNKNOWN RESPONSE - data = #{data} - message = #{message}."
+            end
+          end
+        else
+          p "Server responded with #{http.response_header}."
+        end
+      end
+    end
+
+    # Lists all current users data, with any additional filters you want.
+    # If you provide a block it will yield the response, otherwise it will be sent the log.
+    # TODO: Replace USER.USER_STATE with something we know will get all users.
+    def users filter = ""
+      filter = 'USER.USER_STATE="Unknown"' if filter.empty?
+      data = {
+          cd:               82,
+          token:            Comufyrails.config.access_token,
+          applicationName:  Comufyrails.config.app_name,
+          since:            1314835200000,
+          fetchMode:        "ALL",
+          filter:           filter
+      }
+
+      EM.synchrony do
+        http = EventMachine::HttpRequest.new(Comufyrails.config.url).post(
+            :body => { request: data.to_json }, :initheader => { 'Content-Type' => 'application/json' })
+        if http.response_header.status == 200
+          message = JSON.parse(http.response)
+          if block_given?
+            yield message
+          else
+            case message["cd"]
+              when 382 then
+                p "382 - Success! - data = #{data} - message = #{message}."
+              when 692 then
+                p "692 - Invalid filter/filter not found - data = #{data} - message = #{message}."
+              else
+                p "UNKNOWN RESPONSE - data = #{data} - message = #{message}."
+            end
+          end
+        else
+          p "Server responded with #{http.response_header}."
+        end
+      end
+    end
+
+  end
 
-  # with this in mind, we will probably be using https://github.com/igrigorik/em-synchrony
-  # with apost and post requests to send and receive data. It'll use the information generated from the Railtie
-  # to know what/who is sending and to where.
 end

data/lib/comufyrails/constants.rb

@@ -0,0 +1,21 @@
+module Comufyrails
+  # String data accepted (this is the usual type to use)
+  STRING_TYPE = "STRING"
+  # Date data (1988-10-01 19:50:48 YYYY-MM-DD HH:mm:SS)
+  DATE_TYPE   = "DATE"
+  # Gender data (TODO: format?)
+  GENDER_TYPE = "GENDER"
+  # Integer data accepted (32-bit)
+  INT_TYPE    = "INT"
+  # Float data accepted (32-bit float)
+  FLOAT_TYPE  = "FLOAT"
+  # Data types must be one of these formats
+  LEGAL_TYPES = [STRING_TYPE, DATE_TYPE, GENDER_TYPE, INT_TYPE, FLOAT_TYPE]
+
+  # Name tags
+  NAME_TAG    = :name
+  # Type tags
+  TYPE_TAG    = :type
+  # Allowed tag keys
+  LEGAL_TAGS  = [NAME_TAG, TYPE_TAG]
+end

data/lib/comufyrails/core_ext.rb

@@ -0,0 +1,21 @@
+
+String.class_eval do
+  def to_comufy_time
+    time = DateTime.parse(self)
+    time.strftime("%Y-%m-%d %H:%M:%S")
+  end
+end
+
+DateTime.class_eval do
+  def to_comufy_time
+    self.strftime("%Y-%m-%d %H:%M:%S")
+  end
+end
+
+if defined?(Rails) and defined?(ActiveSupport)
+  ActiveSupport::TimeWithZone.class_eval do
+    def to_comufy_time
+      self.strftime("%Y-%m-%d %H:%M:%S")
+    end
+  end
+end

data/lib/comufyrails/railtie.rb

@@ -1,54 +1,29 @@
 require 'rails'
+require 'comufyrails'
 
 class Comufyrails::Railtie < Rails::Railtie
 
   # this allows users to manage settings just like they manage rails settings
   config.comufy_rails = ActiveSupport::OrderedOptions.new # enable namespaced configuration in Rails environment
 
-  rake_tasks do
-    # load "path/to/my_railtie.tasks"
+  # initialize our logger
+  initializer 'Rails logger' do
+    Comufyrails.logger = Rails.logger
   end
 
   initializer "comufyrails.configure" do |app|
-    Comufyrails.configure do |config|
-      config.app_name     = app.config.comufy_rails[:app_name]      || Comufyrails::Railtie.app_name
-      config.username     = app.config.comufy_rails[:username]      || Comufyrails::Railtie.username
-      config.password     = app.config.comufy_rails[:password]      || Comufyrails::Railtie.password
-      config.access_token = app.config.comufy_rails[:access_token]  || Comufyrails::Railtie.access_token
-      config.expiry_time  = app.config.comufy_rails[:expiry_time]   || Comufyrails::Railtie.expiry_time
-      config.base_api_url = app.config.comufy_rails[:base_api_url]  || Comufyrails::Railtie.base_api_url
+    Comufyrails.configure do |c|
+      c.app_name     = app.config.comufy_rails[:app_name]     || ENV.fetch('COMUFY_APP_NAME',     ::Rails.application.class.to_s.split("::").first)
+      c.access_token = app.config.comufy_rails[:access_token] || ENV.fetch('COMUFY_TOKEN',        nil)
+      c.url          = app.config.comufy_rails[:url]          || ENV.fetch('COMUFY_URL', 'http://www.sociableapi.com/xcoreweb/client')
+
+      # we just want a date far into the future
+      c.expiry_time  = Time.now.to_i + 1000000
     end
   end
 
-  # Add a to_prepare block which is executed once in production
-  # and before each request in development
-  config.to_prepare do
-    # something
+  # load our rake tasks into this rails environment.
+  rake_tasks do
+    load "tasks/comufyrails.rake"
   end
-
-  private
-
-    def self.app_name
-      ENV.fetch('COMUFY_APP_NAME', ::Rails.application.class.to_s.split("::").first)
-    end
-
-    def self.username
-      ENV.fetch('COMUFY_USER', nil)
-    end
-
-    def self.password
-      ENV.fetch('COMUFY_PASSWORD', nil)
-    end
-
-    def self.access_token
-      ENV.fetch('COMUFY_TOKEN', nil)
-    end
-
-    def self.expiry_time
-      ENV.fetch('COMUFY_EXPIRY_TIME', nil)
-    end
-
-    def self.base_api_url
-      'http://www.sociableapi.com/xcoreweb/client'
-    end
 end

data/lib/comufyrails/version.rb

@@ -1,3 +1,4 @@
 module Comufyrails
-  VERSION = "0.0.2"
+  # Current version of this gem.
+  VERSION = "0.1.0"
 end

data/lib/tasks/comufyrails.rake

@@ -0,0 +1,131 @@
+require 'json'
+require 'net/http'
+require 'net/https'
+
+namespace :comufy do
+
+  desc "Register a tag with your application. The type be
+        #{Comufyrails::LEGAL_TYPES.to_sentence(two_words_connector: ' or ', last_word_connector: ', or ')},
+        if empty it defaults to STRING."
+  task :tag , [:name, :type] => :environment do |t, args|
+    raise ArgumentError, "Must specify a name for the tag." unless args.name
+    args.with_defaults(type: 'STRING')
+
+    if Comufyrails.config.app_name.blank?
+      p "
+        Cannot find the application name, is it currently set to nil or an empty string?\n
+        Please check config.comufy_rails.app_name in your environment initializer or the environment variable
+        COMUFY_APP_NAME are valid strings.
+        "
+    elsif Comufyrails.config.base_api_url.blank?
+      p "
+        Cannot find the base api url, is it currently set to nil or an empty string?\n
+        Please check config.comufy_rails.base_api_url in your environment initializer or the environment variable
+        COMUFY_BASE_API_URL are valid strings.
+        "
+    elsif Comufyrails.config.access_token.blank?
+      p "
+        Cannot find the access token, is it currently set to nil or an empty string?\n
+        Please check config.comufy_rails.access_token in your environment initializer or the environment variable
+        COMUFY_TOKEN are valid strings.
+        "
+    elsif not Comufyrails::LEGAL_TYPES.include?(args.type)
+      p "The type must be #{Comufyrails::LEGAL_TYPES.to_sentence(
+          two_words_connector: ' or ', last_word_connector: ', or ')}"
+    else
+      data = {
+          cd:              86,
+          applicationName: Comufyrails.config.app_name,
+          token:           Comufyrails.config.access_token,
+          tags:            [{
+                                name: args.name,
+                                type: args.type.to_sym
+                            }]
+      }
+      response = call_api(Comufyrails.config.url, data)
+
+      if response.message == 'OK'
+        message = JSON.parse(response.read_body)
+        case message["cd"]
+          when 386 then
+            p "386 - Success! - data = #{data} - message = #{message}."
+          when 475 then
+            p "475 - Invalid parameters provided - data = #{data} - message = #{message}."
+          when 603 then
+            p "603 - _ERROR_DOMAIN_APPLICATION_NAME_NOT_FOUND - data = #{data} - message = #{message}."
+          when 607 then
+            p "607 - _ERROR_UNAUTHORISED_ACTION - data = #{data} - message = #{message}."
+          when 618 then
+            p "618 - _ERROR_DOMAIN_APPLICATION_TAG_ALREADY_REGISTERED - data = #{data} - message = #{message}."
+          else
+            p  "UNKNOWN RESPONSE - data = #{data} - message = #{message}."
+        end
+      else
+        p "Authentication failed when sending #{data}. Please get in touch with Comufy if you cannot resolve this."
+      end
+    end
+  end
+
+  desc "Unregister an existing tag from your application."
+  task :detag , [:name] => :environment do |t, args|
+    raise ArgumentError, "Must specify a name for the tag." unless args.name
+
+    if Comufyrails.config.app_name.blank?
+      p "
+        Cannot find the application name, is it currently set to nil or an empty string?\n
+        Please check config.comufy_rails.app_name in your environment initializer or the environment variable
+        COMUFY_APP_NAME are valid strings.
+        "
+    elsif Comufyrails.config.base_api_url.blank?
+      p "
+        Cannot find the base api url, is it currently set to nil or an empty string?\n
+        Please check config.comufy_rails.base_api_url in your environment initializer or the environment variable
+        COMUFY_BASE_API_URL are valid strings.
+        "
+    elsif Comufyrails.config.access_token.blank?
+      p "
+        Cannot find the access token, is it currently set to nil or an empty string?\n
+        Please check config.comufy_rails.access_token in your environment initializer or the environment variable
+        COMUFY_TOKEN are valid strings.
+        "
+    else
+      data = {
+          cd:              85,
+          applicationName: Comufyrails.config.app_name,
+          token:           Comufyrails.config.access_token,
+          tag:             args.name
+      }
+      response = call_api(Comufyrails.config.url, data)
+
+      if response.message == 'OK'
+        message = JSON.parse(response.read_body)
+        case message['cd']
+          when 385 then
+            p "385 - Success! - data = #{data} - message = #{message}."
+          when 475 then
+            p "475 - Invalid parameters provided - data = #{data} - message = #{message}."
+          when 603 then
+            p "603 - _ERROR_DOMAIN_APPLICATION_NAME_NOT_FOUND - data = #{data} - message = #{message}."
+          when 607 then
+            p "607 - _ERROR_UNAUTHORISED_ACTION - data = #{data} - message = #{message}."
+          when 617 then
+            p "617 - _ERROR_DOMAIN_APPLICATION_TAG_NOT_FOUND - data = #{data} - message = #{message}."
+          else
+            p "UNKNOWN RESPONSE - data = #{data} - message = #{message}."
+        end
+      end
+    end
+  end
+
+  private
+
+  # posts the form to the given url as json and blocks till a response is given.
+  def call_api(url, data)
+    uri = URI.parse(url)
+    http = Net::HTTP.new(uri.host, uri.port)
+    request = Net::HTTP::Post.new(uri.path, initheader = { 'Content-Type' => 'application/json' })
+    request.set_form_data({ request: data.to_json })
+    http.request(request)
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: comufyrails
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-21 00:00:00.000000000 Z
+date: 2013-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -27,6 +27,38 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: em-synchrony
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: em-http-request
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -75,8 +107,11 @@ files:
 - comufyrails.gemspec
 - lib/comufyrails.rb
 - lib/comufyrails/connection.rb
+- lib/comufyrails/constants.rb
+- lib/comufyrails/core_ext.rb
 - lib/comufyrails/railtie.rb
 - lib/comufyrails/version.rb
+- lib/tasks/comufyrails.rake
 homepage: https://github.com/plcstevens/comufyrails
 licenses: []
 post_install_message: 
@@ -100,5 +135,5 @@ rubyforge_project:
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: comufyrails-0.0.2
+summary: comufyrails-0.1.0
 test_files: []