comufyrails 0.1.8 → 0.1.10

data/README.md

@@ -9,18 +9,23 @@ messages to your users.
 
 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"
+```bash
+$ gem 'comufyrails'
+$ gem 'comufyrails', :git => "git://github.com/plcstevens/comufyrails.git"
+$ gem 'comufyrails', :path => "/path/to/comufyrails/directory"
+```
 
 And then execute:
 
-    $ bundle
+```bash
+$ bundle
+```
 
 Or install it yourself:
 
-    $ gem install comufyrails
-
+```bash
+$ gem install comufyrails
+```
 
 ## Web servers
 
@@ -39,7 +44,12 @@ 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
+```bash
+$ heroku config | grep COMUFY
+COMUFY_APP_NAME:            Your Facebook Application Name
+COMUFY_TOKEN:               Your Access Token
+COMUFY_URL:                 The URL you use to access Comufys API
+```
 
 ### Application Name
 
@@ -63,7 +73,7 @@ config.comufy_rails.url           = 'COMUFY'
 
 Alternatively you can set these in your environment/path.
 
-```
+```text
 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.

data/lib/comufyrails/connection.rb

@@ -74,18 +74,18 @@ module Comufyrails
             message = JSON.parse(http.response)
             case message["cd"]
               when 388 then
-                Comufyrails.logger.debug("388 - Success! - data = #{data} - message = #{message}.")
+                Comufyrails.logger.debug("Success! Method: store_users, data: #{data}, response: #{message}.")
               when 475 then
-                Comufyrails.logger.debug("475 - Invalid parameter provided. - data = #{data} - message = #{message}.")
+                Comufyrails.logger.debug("Invalid parameter provided! Method: store_users, data: #{data}, response: #{message}.")
               when 617 then
-                Comufyrails.logger.debug("617 - Some of the tags passed are not registered. - data = #{data} - message = #{message}.")
+                Comufyrails.logger.debug("Some of the tags passed are not registered! Method: store_users, data: #{data}, response: #{message}.")
               when 632 then
-                Comufyrails.logger.debug("632 - _ERROR_FACEBOOK_PAGE_NOT_FOUND - data = #{data} - message = #{message}.")
+                Comufyrails.logger.debug("_ERROR_FACEBOOK_PAGE_NOT_FOUND! Method: store_users, data: #{data}, response: #{message}.")
               else
-                Comufyrails.logger.debug("UNKNOWN RESPONSE - data = #{data} - message = #{message}.")
+                Comufyrails.logger.debug("Unknown response from server! Method: store_users, data: #{data}, response: #{message}.")
             end
           else
-            Comufyrails.logger.warn("Server responded with #{http.response_header}.")
+            Comufyrails.logger.warn("Bad response from server: #{http.response_header}.")
           end
         end
       end
@@ -160,30 +160,30 @@ module Comufyrails
             message = JSON.parse(http.response)
             case message["cd"]
               when 383 then
-                Comufyrails.logger.debug("383 - Success! - data = #{data} - message = #{message}.")
+                Comufyrails.logger.debug("Success! Method: send_facebook_message, data: #{data}, response: #{message}.")
               when 416 then
-                Comufyrails.logger.debug("416 - _ERROR_MSG_SEND_FAILED - data = #{data} - message = #{message}.")
+                Comufyrails.logger.debug("_ERROR_MSG_SEND_FAILED! Method: send_facebook_message, data: #{data}, response: #{message}.")
               when 475 then
-                Comufyrails.logger.debug("475 - Invalid parameters provided - data = #{data} - message = #{message}.")
+                Comufyrails.logger.debug("Invalid parameters provided! Method: send_facebook_message, data: #{data}, response: #{message}.")
               when 551 then
-                Comufyrails.logger.debug("551 _ERROR_TAG_VALUE_NOT_FOUND - data = #{data} - message = #{message}.")
+                Comufyrails.logger.debug("_ERROR_TAG_VALUE_NOT_FOUND! Method: send_facebook_message, data: #{data}, response: #{message}.")
               when 603 then
-                Comufyrails.logger.debug("603 - _ERROR_DOMAIN_APPLICATION_NAME_NOT_FOUND - data = #{data} - message = #{message}.")
+                Comufyrails.logger.debug("_ERROR_DOMAIN_APPLICATION_NAME_NOT_FOUND! Method: send_facebook_message, data: #{data}, response: #{message}.")
               when 607 then
-                Comufyrails.logger.debug("607 - _ERROR_UNAUTHORISED_ACTION - data = #{data} - message = #{message}.")
+                Comufyrails.logger.debug("_ERROR_UNAUTHORISED_ACTION! Method: send_facebook_message, data: #{data}, response: #{message}.")
               when 617 then
-                Comufyrails.logger.debug("617 - _ERROR_DOMAIN_APPLICATION_TAG_NOT_FOUND - data = #{data} - message = #{message}.")
+                Comufyrails.logger.debug("_ERROR_DOMAIN_APPLICATION_TAG_NOT_FOUND! Method: send_facebook_message, data: #{data}, response: #{message}.")
               when 648 then
-                Comufyrails.logger.debug("648 - _ERROR_FACEBOOK_APPLICATION_USER_NOT_FOUND - data = #{data} - message = #{message}.")
+                Comufyrails.logger.debug("_ERROR_FACEBOOK_APPLICATION_USER_NOT_FOUND! Method: send_facebook_message, data: #{data}, response: #{message}.")
               when 673 then
-                Comufyrails.logger.debug("673 - Invalid time exception - data = #{data} - message = #{message}.")
+                Comufyrails.logger.debug("Invalid time exception! Method: send_facebook_message, data: #{data}, response: #{message}.")
               when 679 then
-                Comufyrails.logger.debug("679 - _ERROR_MALFORMED_TARGETING_EXPRESSION - data = #{data} - message = #{message}.")
+                Comufyrails.logger.debug("_ERROR_MALFORMED_TARGETING_EXPRESSION! Method: send_facebook_message, data: #{data}, response: #{message}.")
               else
-                Comufyrails.logger.debug("UNKNOWN RESPONSE - data = #{data} - message = #{message}.")
+                Comufyrails.logger.debug("Unknown response from server! Method: send_facebook_message, data: #{data}, response: #{message}.")
             end
           else
-            Comufyrails.logger.warn("Server responded with #{http.response_header}.")
+            Comufyrails.logger.warn("Bad response from server: #{http.response_header}.")
           end
         end
       end
@@ -203,17 +203,18 @@ module Comufyrails
           if http.response_header.status == 200
             message = JSON.parse(http.response)
             if block_given?
+              # TODO: Cut into the response to make it easier for users to use this function.
               yield message
             else
               case message["cd"]
                 when 219 then
-                  Comufyrails.logger.debug("219 - Success! - data = #{data} - message = #{message}.")
+                  Comufyrails.logger.debug("Success! method: tags, data: #{data}, response: #{message}.")
                 else
-                  Comufyrails.logger.debug("UNKNOWN RESPONSE - data = #{data} - message = #{message}.")
+                  Comufyrails.logger.debug("Unknown response from server! Method: tags, data: #{data}, response: #{message}.")
               end
             end
           else
-            Comufyrails.logger.warn("Server responded with #{http.response_header}.")
+            Comufyrails.logger.warn("Bad response from server: #{http.response_header}.")
           end
         end
       end
@@ -259,18 +260,18 @@ module Comufyrails
             else
               case message["cd"]
                 when 382 then
-                  Comufyrails.logger.debug("382 - Success! - data = #{data} - message = #{message}.")
+                  Comufyrails.logger.debug("Success! Method: users, data: #{data}, response: #{message}.")
                   Comufyrails.logger.info("#{total} user(s) were found matching your filter.\n #{users}")
                 when 692 then
-                  Comufyrails.logger.debug("692 - Invalid filter/filter not found - data = #{data} - message = #{message}.")
-                  Comufyrails.logger.info("Invalid filter/filter not found.\n #{users}")
+                  Comufyrails.logger.debug("Invalid filter/filter not found! Method: users, data: #{data}, response: #{message}.")
+                  Comufyrails.logger.info("Invalid filter/filter not found. #{users}")
                 else
-                  Comufyrails.logger.debug("UNKNOWN RESPONSE - data = #{data} - message = #{message}.")
-                  Comufyrails.logger.info("Unknown response from server.\n #{users}")
+                  Comufyrails.logger.debug("Unknown response from server! Method: users, data: #{data}, response: #{message}.")
+                  Comufyrails.logger.info("Unknown response from server. #{users}")
               end
             end
           else
-            Comufyrails.logger.warn("Server responded with #{http.response_header}, rather than the expected 200.")
+            Comufyrails.logger.warn("Bad response from server: #{http.response_header}.")
           end
         end
       end

data/lib/comufyrails/version.rb

@@ -1,4 +1,4 @@
 module Comufyrails
   # Current version of this gem.
-  VERSION = "0.1.8"
+  VERSION = "0.1.10"
 end

data/lib/tasks/comufyrails.rake

@@ -10,21 +10,23 @@ namespace :comufy do
     raise ArgumentError, "Must specify a name for the tag." unless args.name
     args.with_defaults(type: 'STRING')
 
+    Comufyrails.logger = Logger.new(STDOUT) if Rails.env.development?
+
     if Comufyrails.config.app_name.blank?
-      Comufyrails.logger.info("Cannot find the application name, is it currently set to nil or an empty string? Please check
-                  config.comufy_rails.app_name in your environment initializer or the environment variable
+      Comufyrails.logger.error("Cannot find the application name, is it currently set to nil or an empty string? Please
+                  check config.comufy_rails.app_name in your environment initializer or the environment variable
                   COMUFY_APP_NAME are valid strings. And remember you need to register your application with Comufy
                   first with the comufy:app rake command.")
     elsif Comufyrails.config.url.blank?
-      Comufyrails.logger.info("Cannot find the base api url, is it currently set to nil or an empty string?\n
+      Comufyrails.logger.error("Cannot find the base api url, is it currently set to nil or an empty string?
                   Please check config.comufy_rails.url in your environment initializer or the environment variable
                   COMUFY_URL are valid strings.")
     elsif Comufyrails.config.access_token.blank?
-      Comufyrails.logger.info("Cannot find the access token, is it currently set to nil or an empty string?\n
+      Comufyrails.logger.error("Cannot find the access token, is it currently set to nil or an empty string?
                   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)
-      Comufyrails.logger.info("The type must be #{Comufyrails::LEGAL_TYPES.to_sentence(last_word_connector: ', or ')}")
+      Comufyrails.logger.error("The type must be #{Comufyrails::LEGAL_TYPES.to_sentence(last_word_connector: ', or ')}")
     else
       data = {
           cd:              86,
@@ -36,6 +38,7 @@ namespace :comufy do
                             }]
       }
 
+      Comufyrails.logger.debug("Preparing to add your tag #{args.name} to your application #{Comufyrails.config.app_name}.")
       uri = URI.parse(Comufyrails.config.url)
       http = Net::HTTP.new(uri.host, uri.port)
       http.use_ssl = true
@@ -48,20 +51,26 @@ namespace :comufy do
         case message["cd"]
           when 386 then
             Comufyrails.logger.debug("386 - Success! - data = #{data} - message = #{message}.")
+            Comufyrails.logger.info("Successfully added the tag #{args.name} to your application #{Comufyrails.config.app_name}.")
           when 475 then
             Comufyrails.logger.debug("475 - Invalid parameters provided - data = #{data} - message = #{message}.")
+            Comufyrails.logger.warn("Unable to add your tag #{args.name} to your application #{Comufyrails.config.app_name}.")
           when 603 then
             Comufyrails.logger.debug("603 - _ERROR_DOMAIN_APPLICATION_NAME_NOT_FOUND - data = #{data} - message = #{message}.")
+            Comufyrails.logger.warn("Unable to add your tag #{args.name} to your application #{Comufyrails.config.app_name}.")
           when 607 then
             Comufyrails.logger.debug("607 - _ERROR_UNAUTHORISED_ACTION - data = #{data} - message = #{message}.")
+            Comufyrails.logger.warn("Unable to add your tag #{args.name} to your application #{Comufyrails.config.app_name}.")
           when 618 then
             Comufyrails.logger.debug("618 - _ERROR_DOMAIN_APPLICATION_TAG_ALREADY_REGISTERED - data = #{data} - message = #{message}.")
+            Comufyrails.logger.warn("Unable to add your tag #{args.name} to your application #{Comufyrails.config.app_name}.")
           else
             Comufyrails.logger.debug("UNKNOWN RESPONSE - data = #{data} - message = #{message}.")
+            Comufyrails.logger.warn("Unable to add your tag #{args.name} to your application #{Comufyrails.config.app_name}.")
         end
       else
         Comufyrails.logger.debug("Rake task comufy:tag failed when sending #{data}.")
-        Comufyrails.logger.warn("Authentication failed. Please get in touch with Comufy if you cannot resolve this.")
+        Comufyrails.logger.error("Authentication failed. Please get in touch with Comufy if you cannot resolve this.")
       end
     end
   end
@@ -70,17 +79,19 @@ namespace :comufy do
   task :detag , [:name] => :environment do |t, args|
     raise ArgumentError, "Must specify a name for the tag." unless args.name
 
+    Comufyrails.logger = Logger.new(STDOUT) if Rails.env.development?
+
     if Comufyrails.config.app_name.blank?
-      Comufyrails.logger.info("Cannot find the application name, is it currently set to nil or an empty string? Please check
-                  config.comufy_rails.app_name in your environment initializer or the environment variable
+      Comufyrails.logger.error("Cannot find the application name, is it currently set to nil or an empty string? Please
+                  check config.comufy_rails.app_name in your environment initializer or the environment variable
                   COMUFY_APP_NAME are valid strings. And remember you need to register your application with Comufy
                   first with the comufy:app rake command.")
     elsif Comufyrails.config.url.blank?
-      Comufyrails.logger.info("Cannot find the base api url, is it currently set to nil or an empty string?\n
+      Comufyrails.logger.error("Cannot find the base api url, is it currently set to nil or an empty string?
                   Please check config.comufy_rails.url in your environment initializer or the environment variable
                   COMUFY_URL are valid strings.")
     elsif Comufyrails.config.access_token.blank?
-      Comufyrails.logger.info("Cannot find the access token, is it currently set to nil or an empty string?\n
+      Comufyrails.logger.error("Cannot find the access token, is it currently set to nil or an empty string?
                   Please check config.comufy_rails.access_token in your environment initializer or the environment
                   variable COMUFY_TOKEN are valid strings.")
     else
@@ -91,6 +102,7 @@ namespace :comufy do
           tag:             args.name
       }
 
+      Comufyrails.logger.debug("Preparing to send request to unregister the tag: #{args.name}")
       uri = URI.parse(Comufyrails.config.url)
       http = Net::HTTP.new(uri.host, uri.port)
       http.use_ssl = true
@@ -103,20 +115,26 @@ namespace :comufy do
         case message['cd']
           when 385 then
             Comufyrails.logger.debug("385 - Success! - data = #{data} - message = #{message}.")
+            Comufyrails.logger.warn("Success! Removed your tag #{args.name} from your application #{Comufyrails.config.app_name}.")
           when 475 then
             Comufyrails.logger.debug("475 - Invalid parameters provided - data = #{data} - message = #{message}.")
+            Comufyrails.logger.warn("Unable to remove your tag #{args.name} from your application #{Comufyrails.config.app_name}.")
           when 603 then
             Comufyrails.logger.debug("603 - _ERROR_DOMAIN_APPLICATION_NAME_NOT_FOUND - data = #{data} - message = #{message}.")
+            Comufyrails.logger.warn("Unable to remove your tag #{args.name} from your application #{Comufyrails.config.app_name}.")
           when 607 then
             Comufyrails.logger.debug("607 - _ERROR_UNAUTHORISED_ACTION - data = #{data} - message = #{message}.")
+            Comufyrails.logger.warn("Unable to remove your tag #{args.name} from your application #{Comufyrails.config.app_name}.")
           when 617 then
             Comufyrails.logger.debug("617 - _ERROR_DOMAIN_APPLICATION_TAG_NOT_FOUND - data = #{data} - message = #{message}.")
+            Comufyrails.logger.warn("Unable to remove your tag #{args.name} from your application #{Comufyrails.config.app_name}.")
           else
             Comufyrails.logger.debug("UNKNOWN RESPONSE - data = #{data} - message = #{message}.")
+            Comufyrails.logger.warn("Unable to remove your tag #{args.name} from your application #{Comufyrails.config.app_name}.")
         end
       else
         Comufyrails.logger.debug("Rake task comufy:tag failed when sending #{data}.")
-        Comufyrails.logger.warn("Authentication failed. Please get in touch with Comufy if you cannot resolve this.")
+        Comufyrails.logger.error("Authentication failed. Please get in touch with Comufy if you cannot resolve this.")
       end
     end
   end
@@ -128,12 +146,14 @@ namespace :comufy do
     raise ArgumentError, "Must specify a facebook secret for the application."          unless args.secret
     raise ArgumentError, "Must specify a description for the application."              unless args.description
 
+    Comufyrails.logger = Logger.new(STDOUT) if Rails.env.development?
+
     if Comufyrails.config.url.blank?
-      Comufyrails.logger.info("Cannot find the base api url, is it currently set to nil or an empty string?
+      Comufyrails.logger.error("Cannot find the base api url, is it currently set to nil or an empty string?
                   Please check config.comufy_rails.url in your environment initializer or the environment variable
                   COMUFY_URL are valid strings.")
     elsif Comufyrails.config.access_token.blank?
-      Comufyrails.logger.info("Cannot find the access token, is it currently set to nil or an empty string?
+      Comufyrails.logger.error("Cannot find the access token, is it currently set to nil or an empty string?
                   Please check config.comufy_rails.access_token in your environment initializer or the environment
                   variable COMUFY_TOKEN are valid strings.")
     else
@@ -146,6 +166,7 @@ namespace :comufy do
         applicationSecret:  args.secret
       }
 
+      Comufyrails.logger.debug("Preparing to add your application #{args.name} to Comufy.")
       uri = URI.parse(Comufyrails.config.url)
       http = Net::HTTP.new(uri.host, uri.port)
       http.use_ssl = true
@@ -158,18 +179,23 @@ namespace :comufy do
         case message['cd']
           when 205 then
             Comufyrails.logger.debug("205 - Success! - data = #{data} - message = #{message}.")
+            Comufyrails.logger.warn("Success! Able to add your application #{args.name} to Comufy.")
           when 602 then
             Comufyrails.logger.debug("602 - _ERROR_DOMAIN_APPLICATION_NAME_ALREADY_REGISTERED - data = #{data} - message = #{message}.")
+            Comufyrails.logger.warn("Unable to add your application #{args.name}.")
           when 619 then
             Comufyrails.logger.debug("619 - _ERROR_DOMAIN_APPLICATION_ALREADY_REGISTERED_UNDER_DIFFERENT_NAME  - data = #{data} - message = #{message}.")
+            Comufyrails.logger.warn("Unable to add your application #{args.name}.")
           when 645 then
             Comufyrails.logger.debug("645 - _ERROR_FACEBOOK_AUTHORISATION_FAILURE - data = #{data} - message = #{message}.")
+            Comufyrails.logger.warn("Unable to add your application #{args.name}.")
           else
             Comufyrails.logger.debug("UNKNOWN RESPONSE - data = #{data} - message = #{message}.")
+            Comufyrails.logger.warn("Unable to add your application #{args.name}.")
         end
       else
         Comufyrails.logger.debug("Rake task comufy:tag failed when sending #{data}.")
-        Comufyrails.logger.warn("Authentication failed. Please get in touch with Comufy if you cannot resolve this.")
+        Comufyrails.logger.error("Authentication failed. Please get in touch with Comufy if you cannot resolve this.")
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: comufyrails
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.10
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-14 00:00:00.000000000 Z
+date: 2013-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -134,5 +134,5 @@ rubyforge_project:
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: comufyrails-0.1.8
+summary: comufyrails-0.1.10
 test_files: []