comufyrails 0.1.6 → 0.1.8

data/lib/comufyrails/connection.rb

@@ -13,10 +13,6 @@ require 'comufyrails'
 # also print to the log. This is often useful for debugging, but in practise you should provide these with a block.
 module Comufyrails
   module Connection
-
-    class IllegalKeyTypeError < StandardError; end
-    class IllegalValueTypeError < StandardError; end
-
     class << self
 
       # Shortened method name for storing a user, or users in your Application.
@@ -78,18 +74,18 @@ module Comufyrails
             message = JSON.parse(http.response)
             case message["cd"]
               when 388 then
-                p "388 - Success! - data = #{data} - message = #{message}."
+                Comufyrails.logger.debug("388 - Success! - data = #{data} - message = #{message}.")
               when 475 then
-                p "475 - Invalid parameter provided. - data = #{data} - message = #{message}."
+                Comufyrails.logger.debug("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}."
+                Comufyrails.logger.debug("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}."
+                Comufyrails.logger.debug("632 - _ERROR_FACEBOOK_PAGE_NOT_FOUND - data = #{data} - message = #{message}.")
               else
-                p "UNKNOWN RESPONSE - data = #{data} - message = #{message}."
+                Comufyrails.logger.debug("UNKNOWN RESPONSE - data = #{data} - message = #{message}.")
             end
           else
-            p "Server responded with #{http.response_header}."
+            Comufyrails.logger.warn("Server responded with #{http.response_header}.")
           end
         end
       end
@@ -164,30 +160,30 @@ module Comufyrails
             message = JSON.parse(http.response)
             case message["cd"]
               when 383 then
-                p "383 - Success! - data = #{data} - message = #{message}."
+                Comufyrails.logger.debug("383 - Success! - data = #{data} - message = #{message}.")
               when 416 then
-                p "416 - _ERROR_MSG_SEND_FAILED - data = #{data} - message = #{message}."
+                Comufyrails.logger.debug("416 - _ERROR_MSG_SEND_FAILED - data = #{data} - message = #{message}.")
               when 475 then
-                p "475 - Invalid parameters provided - data = #{data} - message = #{message}."
+                Comufyrails.logger.debug("475 - Invalid parameters provided - data = #{data} - message = #{message}.")
               when 551 then
-                p "551 _ERROR_TAG_VALUE_NOT_FOUND - data = #{data} - message = #{message}."
+                Comufyrails.logger.debug("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}."
+                Comufyrails.logger.debug("603 - _ERROR_DOMAIN_APPLICATION_NAME_NOT_FOUND - data = #{data} - message = #{message}.")
               when 607 then
-                p "607 - _ERROR_UNAUTHORISED_ACTION - data = #{data} - message = #{message}."
+                Comufyrails.logger.debug("607 - _ERROR_UNAUTHORISED_ACTION - data = #{data} - message = #{message}.")
               when 617 then
-                p "617 - _ERROR_DOMAIN_APPLICATION_TAG_NOT_FOUND - data = #{data} - message = #{message}."
+                Comufyrails.logger.debug("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}."
+                Comufyrails.logger.debug("648 - _ERROR_FACEBOOK_APPLICATION_USER_NOT_FOUND - data = #{data} - message = #{message}.")
               when 673 then
-                p "673 - Invalid time exception - data = #{data} - message = #{message}."
+                Comufyrails.logger.debug("673 - Invalid time exception - data = #{data} - message = #{message}.")
               when 679 then
-                p "679 - _ERROR_MALFORMED_TARGETING_EXPRESSION - data = #{data} - message = #{message}."
+                Comufyrails.logger.debug("679 - _ERROR_MALFORMED_TARGETING_EXPRESSION - data = #{data} - message = #{message}.")
               else
-                p "UNKNOWN RESPONSE - data = #{data} - message = #{message}."
+                Comufyrails.logger.debug("UNKNOWN RESPONSE - data = #{data} - message = #{message}.")
             end
           else
-            p "Server responded with #{http.response_header}."
+            Comufyrails.logger.warn("Server responded with #{http.response_header}.")
           end
         end
       end
@@ -211,13 +207,13 @@ module Comufyrails
             else
               case message["cd"]
                 when 219 then
-                  p "219 - Success! - data = #{data} - message = #{message}."
+                  Comufyrails.logger.debug("219 - Success! - data = #{data} - message = #{message}.")
                 else
-                  p "UNKNOWN RESPONSE - data = #{data} - message = #{message}."
+                  Comufyrails.logger.debug("UNKNOWN RESPONSE - data = #{data} - message = #{message}.")
               end
             end
           else
-            p "Server responded with #{http.response_header}."
+            Comufyrails.logger.warn("Server responded with #{http.response_header}.")
           end
         end
       end
@@ -225,10 +221,11 @@ module Comufyrails
       def user(facebook_id)
         filter = "FACEBOOK.ID=\"#{facebook_id}\""
         self.users(filter)  do |users, total, to, from|
-          user    = users.first
-          account = user.delete("account")
-          tags    = user.delete("tagValues")
-          yield account, tags, [users, total, to, from]
+          user    = users.delete_at(0)
+          account = user ? user.delete("account")   : { }
+          tags    = user ? user.delete("tagValues") : { }
+          other   = { users: users, total: total, to: to, from: from }.with_indifferent_access
+          yield account, tags, other
         end
       end
 
@@ -250,25 +247,30 @@ module Comufyrails
           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)
+            message = JSON.parse(http.response).with_indifferent_access
+            blocks  = message.clone.delete("timeBlocks")
+            total = blocks.first ? blocks.first.delete("total")               : 0
+            to    = blocks.first ? blocks.first.delete("to")                  : 0
+            from  = blocks.first ? blocks.first.delete("from")                : 0
+            users = blocks.first && total > 0 ? blocks.first.delete("data")   : [ ]
+
             if block_given?
-              total = message["timeBlocks"][0]["total"]
-              users = message["timeBlocks"][0]["data"]
-              to    = message["timeBlocks"][0]["to"]
-              from  = message["timeBlocks"][0]["from"]
               yield users, total, to, from
             else
               case message["cd"]
                 when 382 then
-                  p "382 - Success! - data = #{data} - message = #{message}."
+                  Comufyrails.logger.debug("382 - Success! - data = #{data} - message = #{message}.")
+                  Comufyrails.logger.info("#{total} user(s) were found matching your filter.\n #{users}")
                 when 692 then
-                  p "692 - Invalid filter/filter not found - data = #{data} - message = #{message}."
+                  Comufyrails.logger.debug("692 - Invalid filter/filter not found - data = #{data} - message = #{message}.")
+                  Comufyrails.logger.info("Invalid filter/filter not found.\n #{users}")
                 else
-                  p "UNKNOWN RESPONSE - data = #{data} - message = #{message}."
+                  Comufyrails.logger.debug("UNKNOWN RESPONSE - data = #{data} - message = #{message}.")
+                  Comufyrails.logger.info("Unknown response from server.\n #{users}")
               end
             end
           else
-            p "Server responded with #{http.response_header}."
+            Comufyrails.logger.warn("Server responded with #{http.response_header}, rather than the expected 200.")
           end
         end
       end

data/lib/comufyrails/railtie.rb

@@ -1,16 +1,17 @@
 require 'rails'
 require 'comufyrails'
 
+# :nodoc:
 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
+  # enable namespaced configuration in Rails environment
+  config.comufy_rails = ActiveSupport::OrderedOptions.new
 
-  # initialize our logger
   initializer 'Rails logger' do
     Comufyrails.logger = Rails.logger
   end
 
+  # configure the key settings that Comufyrails requires to functions
   initializer "comufyrails.configure" do |app|
     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)

data/lib/comufyrails/version.rb

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

data/lib/comufyrails.rb

@@ -6,6 +6,7 @@ require "comufyrails/constants"
 require "comufyrails/connection"
 require 'comufyrails/railtie' if defined?(Rails)
 
+# :nodoc:
 module Comufyrails
 
   # Contains the list of constant variables that will be used throughout this gem.
@@ -21,7 +22,6 @@ module Comufyrails
   end
 
   class << self
-    # Comufyrails logger (usually uses the Rails.logger)
     attr_accessor :logger
 
     # define as a Config object unless defined

data/lib/tasks/comufyrails.rake

@@ -11,24 +11,20 @@ namespace :comufy do
     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? 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."
+      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
+                  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?
-      p "
-Cannot find the base api url, is it currently set to nil or an empty string?\n
-Please check config.comufy_rails.url in your environment initializer or the environment variable
-COMUFY_URL are valid strings."
+      Comufyrails.logger.info("Cannot find the base api url, is it currently set to nil or an empty string?\n
+                  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?
-      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."
+      Comufyrails.logger.info("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 ')}"
+      Comufyrails.logger.info("The type must be #{Comufyrails::LEGAL_TYPES.to_sentence(last_word_connector: ', or ')}")
     else
       data = {
           cd:              86,
@@ -51,20 +47,21 @@ The type must be #{Comufyrails::LEGAL_TYPES.to_sentence(two_words_connector: ' o
         message = JSON.parse(response.read_body)
         case message["cd"]
           when 386 then
-            p "386 - Success! - data = #{data} - message = #{message}."
+            Comufyrails.logger.debug("386 - Success! - data = #{data} - message = #{message}.")
           when 475 then
-            p "475 - Invalid parameters provided - data = #{data} - message = #{message}."
+            Comufyrails.logger.debug("475 - Invalid parameters provided - data = #{data} - message = #{message}.")
           when 603 then
-            p "603 - _ERROR_DOMAIN_APPLICATION_NAME_NOT_FOUND - data = #{data} - message = #{message}."
+            Comufyrails.logger.debug("603 - _ERROR_DOMAIN_APPLICATION_NAME_NOT_FOUND - data = #{data} - message = #{message}.")
           when 607 then
-            p "607 - _ERROR_UNAUTHORISED_ACTION - data = #{data} - message = #{message}."
+            Comufyrails.logger.debug("607 - _ERROR_UNAUTHORISED_ACTION - data = #{data} - message = #{message}.")
           when 618 then
-            p "618 - _ERROR_DOMAIN_APPLICATION_TAG_ALREADY_REGISTERED - data = #{data} - message = #{message}."
+            Comufyrails.logger.debug("618 - _ERROR_DOMAIN_APPLICATION_TAG_ALREADY_REGISTERED - data = #{data} - message = #{message}.")
           else
-            p  "UNKNOWN RESPONSE - data = #{data} - message = #{message}."
+            Comufyrails.logger.debug("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."
+        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.")
       end
     end
   end
@@ -74,21 +71,18 @@ The type must be #{Comufyrails::LEGAL_TYPES.to_sentence(two_words_connector: ' o
     raise ArgumentError, "Must specify a name for the tag." unless args.name
 
     if Comufyrails.config.app_name.blank?
-      puts "
-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."
+      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
+                  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?
-      p "
-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."
+      Comufyrails.logger.info("Cannot find the base api url, is it currently set to nil or an empty string?\n
+                  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?
-      p "
-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."
+      Comufyrails.logger.info("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,
@@ -108,20 +102,21 @@ COMUFY_TOKEN are valid strings."
         message = JSON.parse(response.read_body)
         case message['cd']
           when 385 then
-            p "385 - Success! - data = #{data} - message = #{message}."
+            Comufyrails.logger.debug("385 - Success! - data = #{data} - message = #{message}.")
           when 475 then
-            p "475 - Invalid parameters provided - data = #{data} - message = #{message}."
+            Comufyrails.logger.debug("475 - Invalid parameters provided - data = #{data} - message = #{message}.")
           when 603 then
-            p "603 - _ERROR_DOMAIN_APPLICATION_NAME_NOT_FOUND - data = #{data} - message = #{message}."
+            Comufyrails.logger.debug("603 - _ERROR_DOMAIN_APPLICATION_NAME_NOT_FOUND - data = #{data} - message = #{message}.")
           when 607 then
-            p "607 - _ERROR_UNAUTHORISED_ACTION - data = #{data} - message = #{message}."
+            Comufyrails.logger.debug("607 - _ERROR_UNAUTHORISED_ACTION - data = #{data} - message = #{message}.")
           when 617 then
-            p "617 - _ERROR_DOMAIN_APPLICATION_TAG_NOT_FOUND - data = #{data} - message = #{message}."
+            Comufyrails.logger.debug("617 - _ERROR_DOMAIN_APPLICATION_TAG_NOT_FOUND - data = #{data} - message = #{message}.")
           else
-            p "UNKNOWN RESPONSE - data = #{data} - message = #{message}."
+            Comufyrails.logger.debug("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."
+        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.")
       end
     end
   end
@@ -134,15 +129,13 @@ COMUFY_TOKEN are valid strings."
     raise ArgumentError, "Must specify a description for the application."              unless args.description
 
     if Comufyrails.config.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.url in your environment initializer or the environment variable
-COMUFY_URL are valid strings."
+      Comufyrails.logger.info("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?
-      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."
+      Comufyrails.logger.info("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
       data = {
         cd:                 106,
@@ -164,18 +157,19 @@ COMUFY_TOKEN are valid strings."
         message = JSON.parse(response.read_body)
         case message['cd']
           when 205 then
-            p "205 - Success! - data = #{data} - message = #{message}."
+            Comufyrails.logger.debug("205 - Success! - data = #{data} - message = #{message}.")
           when 602 then
-            p "602 - _ERROR_DOMAIN_APPLICATION_NAME_ALREADY_REGISTERED - data = #{data} - message = #{message}."
+            Comufyrails.logger.debug("602 - _ERROR_DOMAIN_APPLICATION_NAME_ALREADY_REGISTERED - data = #{data} - message = #{message}.")
           when 619 then
-            p "619 - _ERROR_DOMAIN_APPLICATION_ALREADY_REGISTERED_UNDER_DIFFERENT_NAME  - data = #{data} - message = #{message}."
+            Comufyrails.logger.debug("619 - _ERROR_DOMAIN_APPLICATION_ALREADY_REGISTERED_UNDER_DIFFERENT_NAME  - data = #{data} - message = #{message}.")
           when 645 then
-            p "645 - _ERROR_FACEBOOK_AUTHORISATION_FAILURE - data = #{data} - message = #{message}."
+            Comufyrails.logger.debug("645 - _ERROR_FACEBOOK_AUTHORISATION_FAILURE - data = #{data} - message = #{message}.")
           else
-            p "UNKNOWN RESPONSE - data = #{data} - message = #{message}."
+            Comufyrails.logger.debug("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."
+        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.")
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: comufyrails
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-11 00:00:00.000000000 Z
+date: 2013-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -99,7 +99,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
-- .rvmrc
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -135,5 +134,5 @@ rubyforge_project:
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: comufyrails-0.1.6
+summary: comufyrails-0.1.8
 test_files: []

data/.rvmrc

@@ -1,48 +0,0 @@
-#!/usr/bin/env bash
-
-# This is an RVM Project .rvmrc file, used to automatically load the ruby
-# development environment upon cd'ing into the directory
-
-# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
-# Only full ruby name is supported here, for short names use:
-#     echo "rvm use 1.9.3" > .rvmrc
-environment_id="ruby-1.9.3-p327@comufyrails"
-
-# Uncomment the following lines if you want to verify rvm version per project
-# rvmrc_rvm_version="1.17.3 (master)" # 1.10.1 seams as a safe start
-# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
-#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
-#   return 1
-# }
-
-# First we attempt to load the desired environment directly from the environment
-# file. This is very fast and efficient compared to running through the entire
-# CLI and selector. If you want feedback on which environment was used then
-# insert the word 'use' after --create as this triggers verbose mode.
-if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
-  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
-then
-  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
-  [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]] &&
-    \. "${rvm_path:-$HOME/.rvm}/hooks/after_use" || true
-else
-  # If the environment file has not yet been created, use the RVM CLI to select.
-  rvm --create  "$environment_id" || {
-    echo "Failed to create RVM environment '${environment_id}'."
-    return 1
-  }
-fi
-
-# If you use bundler, this might be useful to you:
-# if [[ -s Gemfile ]] && {
-#   ! builtin command -v bundle >/dev/null ||
-#   builtin command -v bundle | GREP_OPTIONS= \grep $rvm_path/bin/bundle >/dev/null
-# }
-# then
-#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
-#   gem install bundler
-# fi
-# if [[ -s Gemfile ]] && builtin command -v bundle >/dev/null
-# then
-#   bundle install | GREP_OPTIONS= \grep -vE '^Using|Your bundle is complete'
-# fi