zenbox 0.0.3 → 0.0.4

data/lib/{contextify → zenbox}/sender.rb

@@ -1,8 +1,8 @@
-module Contextify
-  # Sends out the notice to Contextify
+module Zenbox
+  # Sends out the notice to Zenbox
   class Sender
 
-    CUSTOMERS_URI = '/customers'.freeze
+    CUSTOMERS_URI = '/customers.json'.freeze
     HTTP_ERRORS = [Timeout::Error,
                    Errno::EINVAL,
                    Errno::ECONNRESET,
@@ -29,10 +29,10 @@ module Contextify
       end
     end
 
-    # Sends the customer data off to Contextify for processing.
+    # Sends the customer data off to Zenbox for processing.
     #
     # @param [String] data The JSON notice to be sent off
-    def send_to_contextify(data)
+    def send_to_zenbox(data)
       http = setup_http_connection
 
       # Set up POST request with formdata and headers
@@ -43,7 +43,7 @@ module Contextify
       response = begin
                    http.request(request)
                  rescue *HTTP_ERRORS => e
-                   log :error, "Timeout while contacting the Contextify server."
+                   log :error, "Timeout while contacting the Zenbox server."
                    nil
                  end
 
@@ -57,7 +57,7 @@ module Contextify
       end
 
     rescue => e
-      log :error, "[Contextify::Sender#send_to_contextify] Cannot send notification. Error: #{e.class} - #{e.message}\nBacktrace:\n#{e.backtrace.join("\n\t")}"
+      log :error, "[Zenbox::Sender#send_to_zenbox] Cannot send notification. Error: #{e.class} - #{e.message}\nBacktrace:\n#{e.backtrace.join("\n\t")}"
       nil
     end
 
@@ -84,11 +84,11 @@ module Contextify
 
     def log(level, message, response = nil)
       logger.send level, LOG_PREFIX + message if logger
-      Contextify.report_response_body(response.body) if response && response.respond_to?(:body)
+      Zenbox.report_response_body(response.body) if response && response.respond_to?(:body)
     end
 
     def logger
-      Contextify.logger
+      Zenbox.logger
     end
 
     def setup_http_connection
@@ -107,7 +107,7 @@ module Contextify
         # else
         #   http.ca_file     = Sender.local_cert_path # ca-bundle.crt built from source, see resources/README.md
         # end
-        http.ca_file      = Contextify.configuration.ca_bundle_path
+        http.ca_file      = Zenbox.configuration.ca_bundle_path
         http.verify_mode  = OpenSSL::SSL::VERIFY_PEER
       else
         http.use_ssl     = false
@@ -115,7 +115,7 @@ module Contextify
 
       http
     rescue => e
-      log :error, "[Contextify::Sender#setup_http_connection] Failure initializing the HTTP connection.\nError: #{e.class} - #{e.message}\nBacktrace:\n#{e.backtrace.join("\n\t")}"
+      log :error, "[Zenbox::Sender#setup_http_connection] Failure initializing the HTTP connection.\nError: #{e.class} - #{e.message}\nBacktrace:\n#{e.backtrace.join("\n\t")}"
       raise e
     end
 

data/lib/{contextify → zenbox}/shared_tasks.rb

@@ -1,4 +1,4 @@
-namespace :contextify do
+namespace :zenbox do
 
   task :log_stdout do
     require 'logger'

data/lib/zenbox/tasks.rb

@@ -0,0 +1,50 @@
+require 'zenbox'
+require File.join(File.dirname(__FILE__), 'shared_tasks')
+
+namespace :zenbox do
+  desc "Verify your zenbox api_key by sending test data to the zenbox service"
+  task :test => :environment do
+    if defined?(RAILS_DEFAULT_LOGGER)
+      # Rails 2
+      RAILS_DEFAULT_LOGGER.level = Logger::DEBUG
+    else
+      # Rails 3
+      Rails.logger = Logger.new(STDOUT)
+      Rails.logger.level = Logger::DEBUG
+      Zenbox.configure(true) do |config|
+        config.logger = Rails.logger
+      end
+    end
+
+    unless Zenbox.configuration.api_key
+      puts "Zenbox needs an API key configured! Check the README to see how to add it."
+      exit
+    end
+
+    puts "\nPosting dummy data for 'test@example.com'...\n\n"
+
+    if Zenbox.post "test@example.com", {:test_data => 123}
+      puts "\nZenbox is set up and ready to use!"
+    else
+      puts "\nPlease check your Zenbox configuration or network settings."
+    end
+    puts
+  end
+
+  desc "Syncs all user data after the model has been marked. Can be run many times without any side-effects"
+  task :sync => :environment do
+    if Zenbox.model.nil?
+      puts "You must set a model to zenbox. Did you remember to user `zenbox_user :fields...` in your User model? "
+      return
+    end
+
+    model = Zenbox.model.constantize
+
+    puts "Syncing #{model.all.count} models with Zenbox..." 
+
+    model.all.each do |model|
+      model.zenbox_sync!
+    end
+  end
+end
+

data/lib/zenbox/user_helper.rb

@@ -0,0 +1,39 @@
+module Zenbox
+  module UserHelper
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    # TODO: Catch errors because of missing methods and prompt the
+    # user, "Tried to sync a non-existant method with
+    # zenbox. Please make sure to implement #{method_name} on your
+    # model"
+    def zenbox_sync!
+      Zenbox.post(self.email, zenbox_data)
+    end
+
+    def zenbox_data(*fields)
+      fields = fields.empty? ? self.class.class_variable_get('@@zenbox_fields') : fields
+
+      fields.inject({}) { |run, field| run[field] = self.send(field.to_sym); run }
+    end
+
+    module ClassMethods
+      def self.extended(base)
+        base.class_variable_set("@@zenbox_fields", [])
+
+        Zenbox.model = base.to_s
+      end
+
+      def zenbox_fields=(*args)
+        self.class_variable_set("@@zenbox_fields", args)
+      end
+
+      def zenbox_user(*fields)
+        self.send(:zenbox_fields=, *fields)
+
+        after_commit :zenbox_sync!
+      end
+    end
+  end
+end

data/lib/zenbox/version.rb

@@ -0,0 +1,3 @@
+module Zenbox
+  VERSION = "0.0.4"
+end

data/rails/init.rb

@@ -1 +1 @@
-require 'contextify/rails'
+require 'zenbox/rails'

data/resources/README.md

@@ -1,9 +1,9 @@
-Contextify Resources
+Zenbox Resources
 ====================
 
-Contextify has an SSL mode available.
+Zenbox has an SSL mode available.
 SSL Certificate Authority (CA) certificates are not kept current by default on many environments.
-When CA certs are stale, Contextify cannot verify Contextify's production SSL cert and POSTs fail.
+When CA certs are stale, Zenbox cannot verify Zenbox's production SSL cert and POSTs fail.
 To avoid this, we package local CA certs. The production of these certs is detailed here.
 
 

data/{contextify.gemspec → zenbox.gemspec}

@@ -1,20 +1,20 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
-require "contextify/version"
+require "zenbox/version"
 
 Gem::Specification.new do |s|
   s.name        = %q{zenbox}
-  s.version     = Contextify::VERSION.dup
-  s.summary     = %q{Send your user information to our hosted service and contextify your inbox.}
+  s.version     = Zenbox::VERSION.dup
+  s.summary     = %q{Send your user information to our hosted service and zenbox your inbox.}
 
   s.require_paths = ["lib"]
   s.files         = Dir["{generators/**/*,lib/**/*,rails/**/*,resources/*,script/*}"]  +
-    %w(contextify.gemspec Gemfile INSTALL MIT-LICENSE Rakefile README.md install.rb)
+    %w(zenbox.gemspec Gemfile INSTALL MIT-LICENSE Rakefile README.md install.rb)
   s.test_files    = Dir.glob("{test,spec,features}/**/*")
 
   s.add_runtime_dependency("json")
 
-  s.authors = ["Contextify"]
+  s.authors = ["Zenbox"]
   s.email   = %q{support@cloudfuji.com}
   s.homepage = "http://cloudfuji.com"
 

metadata

@@ -1,57 +1,57 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: zenbox
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.0.4
   prerelease: 
-  version: 0.0.3
 platform: ruby
-authors: 
-- Contextify
+authors:
+- Zenbox
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-06-20 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-06-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: json
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *id001
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email: support@cloudfuji.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- generators/contextify/contextify_generator.rb
-- generators/contextify/lib/insert_commands.rb
-- generators/contextify/lib/rake_commands.rb
-- generators/contextify/templates/contextify_tasks.rake
-- generators/contextify/templates/initializer.rb
-- lib/contextify/configuration.rb
-- lib/contextify/rails.rb
-- lib/contextify/railtie.rb
-- lib/contextify/sender.rb
-- lib/contextify/shared_tasks.rb
-- lib/contextify/tasks.rb
-- lib/contextify/user_helper.rb
-- lib/contextify/version.rb
-- lib/contextify.rb
-- lib/rails/generators/contextify/contextify_generator.rb
+files:
+- generators/zenbox/lib/insert_commands.rb
+- generators/zenbox/lib/rake_commands.rb
+- generators/zenbox/templates/initializer.rb
+- generators/zenbox/templates/zenbox_tasks.rake
+- generators/zenbox/zenbox_generator.rb
+- lib/rails/generators/zenbox/zenbox_generator.rb
+- lib/zenbox/configuration.rb
+- lib/zenbox/rails.rb
+- lib/zenbox/railtie.rb
+- lib/zenbox/sender.rb
+- lib/zenbox/shared_tasks.rb
+- lib/zenbox/tasks.rb
+- lib/zenbox/user_helper.rb
+- lib/zenbox/version.rb
 - lib/zenbox.rb
 - rails/init.rb
 - resources/ca-bundle.crt
 - resources/README.md
-- contextify.gemspec
+- zenbox.gemspec
 - Gemfile
 - INSTALL
 - MIT-LICENSE
@@ -60,36 +60,32 @@ files:
 - install.rb
 homepage: http://cloudfuji.com
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 4427809426802100543
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: 4519474910494744129
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 4427809426802100543
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
+      hash: 4519474910494744129
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.17
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Send your user information to our hosted service and contextify your inbox.
+summary: Send your user information to our hosted service and zenbox your inbox.
 test_files: []
-

data/lib/contextify.rb

@@ -1,74 +0,0 @@
-require 'net/http'
-require 'net/https'
-require 'rubygems'
-require 'contextify/version'
-require 'contextify/configuration'
-require 'contextify/sender'
-require 'contextify/user_helper'
-
-require 'contextify/railtie' if defined?(Rails::Railtie)
-
-module Contextify
-  API_VERSION = "1.0"
-  LOG_PREFIX = "** [Contextify] "
-
-  class << self
-    # The sender object is responsible for delivering formatted data to the Contextify server.
-    # Must respond to #send_to_contextify. See Contextify::Sender.
-    attr_accessor :sender
-
-    # Names the Contextify model we should be watching. Set
-    # automatically when using contextify_user
-    attr_accessor :model
-
-    # A Contextify configuration object. Must act like a hash and return sensible
-    # values for all Contextify configuration options. See Contextify::Configuration.
-    attr_writer :configuration
-
-    # Prints out the response body from Contextify for debugging help
-    def report_response_body(response)
-      write_verbose_log("Response from Contextify: \n#{response}")
-    end
-
-    # Writes out the given message to the #logger
-    def write_verbose_log(message)
-      logger.info LOG_PREFIX + message if logger
-    end
-
-    # Look for the Rails logger currently defined
-    def logger
-      self.configuration.logger
-    end
-
-    # Call this method to modify defaults in your initializers.
-    #
-    # @example
-    #   Contextify.configure do |config|
-    #     config.api_key = '1234567890abcdef'
-    #     config.secure  = false
-    #   end
-    def configure(silent = false)
-      yield(configuration)
-      self.sender = Sender.new(configuration)
-    end
-
-    # The configuration object.
-    # @see Contextify.configure
-    def configuration
-      @configuration ||= Configuration.new
-    end
-
-    # Sends data to contextify
-    #
-    # @param [String] email The email address you want to send data about.
-    # @param [Hash] opts Data that will be sent to Contextify.
-    def post(email, data)
-      post_data = {
-        :api_key => configuration.api_key,
-        :email      => email,
-        :data       => data.to_json
-      }
-      sender.send_to_contextify(post_data)
-    end
-  end
-end

data/lib/contextify/tasks.rb

@@ -1,50 +0,0 @@
-require 'contextify'
-require File.join(File.dirname(__FILE__), 'shared_tasks')
-
-namespace :contextify do
-  desc "Verify your contextify api_key by sending test data to the contextify service"
-  task :test => :environment do
-    if defined?(RAILS_DEFAULT_LOGGER)
-      # Rails 2
-      RAILS_DEFAULT_LOGGER.level = Logger::DEBUG
-    else
-      # Rails 3
-      Rails.logger = Logger.new(STDOUT)
-      Rails.logger.level = Logger::DEBUG
-      Contextify.configure(true) do |config|
-        config.logger = Rails.logger
-      end
-    end
-
-    unless Contextify.configuration.api_key
-      puts "Contextify needs an API key configured! Check the README to see how to add it."
-      exit
-    end
-
-    puts "\nPosting dummy data for 'test@example.com'...\n\n"
-
-    if Contextify.post "test@example.com", {:test_data => 123}
-      puts "\nContextify is set up and ready to use!"
-    else
-      puts "\nPlease check your Contextify configuration or network settings."
-    end
-    puts
-  end
-
-  desc "Syncs all user data after the model has been marked. Can be run many times without any side-effects"
-  task :sync => :environment do
-    if Contextify.model.nil?
-      puts "You must set a model to contextify. Did you remember to user `contextify_user :fields...` in your User model? "
-      return
-    end
-
-    model = Contextify.model.constantize
-
-    puts "Syncing #{model.all.count} models with Contextify..." 
-
-    model.all.each do |model|
-      model.contextify_sync!
-    end
-  end
-end
-