keen 0.0.1

data/lib/keen/storage/flat_file_handler.rb

@@ -0,0 +1,55 @@
+require 'fileutils'
+require 'base64'
+require 'zlib'
+
+
+
+module Keen
+  module Storage
+    class FlatFileHandler
+
+      # Paths
+      # -----
+      
+      # Where new events go as they come in:
+      ACTIVE = "active.txt"
+
+      # The temporary file that will store records during processing:
+      PROCESSING = "processing.txt"
+
+      # Records are put here if processing fails:
+      FAILED = "failed.txt"
+
+      def initialize(filepath)
+        @filepath = filepath
+      
+        is_directory?
+        is_writable?
+        is_readable?
+      end
+
+      def dump_contents
+        # move
+      end
+
+      def is_writable?
+        if not FileTest.writable? @filepath
+          raise "Can't write to file: " + @filepath
+        end
+      end
+      
+      def is_readable?
+        if not FileTest.readable? @filepath
+          raise "Can't read from file: " + @filepath
+        end
+      end
+
+      def is_directory?
+        if not FileTest.directory? @filepath
+          raise "Can't read from file: " + @filepath
+        end
+      end
+
+    end
+  end
+end

data/lib/keen/storage/redis_handler.rb

@@ -0,0 +1,155 @@
+require 'fileutils'
+require 'redis'
+require 'json'
+
+module Keen
+  module Storage
+    class Item
+      # Represents one item in the Redis queue.
+      
+      def to_json(options)
+        @event_body.to_json
+      end
+
+      def to_s
+        self.to_json
+      end
+
+      def auth_token
+        @auth_token
+      end
+      
+      def initialize(definition={})
+        @project_id = definition[:project_id]
+        @auth_token = definition[:auth_token]
+        @collection_name = definition[:collection_name]
+        @event_body = definition[:event_body]
+        
+        # TODO: type checking?
+      end
+
+      def save
+        handler = Keen::Storage::RedisHandler.new
+        handler.add_event(self)
+      end
+
+    end
+
+    class ProjectBatch
+      # Represents a batch of records (for a given project)
+      def initialize(project_id, auth_token)
+        @project_id = project_id
+        @auth_token = auth_token
+        @items = []
+      end
+
+      def add_item(item)
+        @items.push(item)
+      end
+    end
+
+    class RedisHandler
+
+      # Keys
+      # ----
+
+      def global_key_prefix
+        "keen-" + Keen::VERSION
+      end
+      
+      def active_queue_key
+        "#{global_key_prefix}.active_queue_key"
+      end
+
+      def processing_queue_key
+        "#{global_key_prefix}.processing_queue_key"
+      end
+
+      def failed_queue_key
+        "#{global_key_prefix}.failed_queue_key"
+      end
+
+      def lock_active_queue_key
+        "lock" + active_queue_key
+      end
+
+      def lock_active_queue
+        # TODO: add locking
+        key = lock_active_queue_key
+      end
+
+      def unlock_active_queue
+        # TODO: add locking
+        key = lock_active_queue_key
+      end
+
+      def record_event(collection_name, event_body)
+        # TODO this is the main public method!
+        # must write..
+      end
+
+      def handle_prior_failures
+        # TODO consume the failed_queue and do something with it (loggly? retry? flat file?)
+      end
+
+      def initialize
+        @redis = Redis.new
+      end
+
+      def get_active_queue_contents
+        # get the list of jsonified hashes back:
+        list = @redis.get active_queue_key
+
+        if not list
+          []
+        end
+      end
+
+      def flush_active_queue
+        @redis.del active_queue_key
+      end
+
+      def set_processing_queue(queue)
+      end
+
+      def process_queue
+        handle_prior_failures
+
+        lock_active_queue
+
+        queue = get_active_queue_contents
+
+        flush_active_queue
+
+        set_processing_queue(queue)
+
+        unlock_active_queue
+
+        # translate the queue strings into Items
+        items = queue.map {|json| Keen::Storage::Item.new(JSON.parse json)}.compact
+
+        collated = collate_items(items)
+      end
+
+      def collate_items(queue)
+        collated = {}
+
+        # traverse backwards so the most recent auth tokens take precedent:
+        queue.reverse_each do |item_hash|
+          if not collated.has_key? item.project_id
+            collated[item.project_id] = {}
+          end
+
+          if not collated[item.project_id].has_key? item.collection_name
+            collated[item.project_id][item.collection_name] = Keen::Storage::ProjectBatch.new
+          end
+
+          collated[item.project_id][item.collection_name].add_item(item)
+        end
+
+        collated
+      end
+
+    end
+  end
+end

data/lib/keen/version.rb

@@ -0,0 +1,3 @@
+module Keen
+  VERSION = "0.0.1"
+end

data/test/keen_spec.rb

@@ -0,0 +1,26 @@
+$LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'keen'
+require 'fakeweb'
+
+describe Keen::Client do
+
+  # Make it so that we don't actually hit keen server during tests:
+  before :all do
+    FakeWeb.register_uri(:any, %r/https:\/\/api.keen.io\//, :body => '{"message": "You tried to reach Keen"}')
+  end
+  
+  # TODO spec it out, lazy bones!
+  #
+  #
+  # Each time an event is logged, we'll store a json-serialized, base64-
+  # encoded, and gzipped hash that loos like this:
+  #
+  # {
+  #   :project_id       => "alsdjfaldskfjadskladsklj",
+  #   :auth_token       => "aslkjflk3wjfaklsjdflkasdjflkadjflakdj211",
+  #   :collection_name  => "purchases",
+  #   :event_body       => {:prop1 => "val1", :prop2 => "val2"},
+  # }
+
+end

metadata

@@ -0,0 +1,234 @@
+--- !ruby/object:Gem::Specification 
+name: keen
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Kyle Wild
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-03-16 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: multi_json
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 17
+        segments: 
+        - 1
+        - 0
+        - 3
+        version: 1.0.3
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: fakeweb
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: system_timer
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 2
+        - 4
+        version: 1.2.4
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 61
+        segments: 
+        - 0
+        - 8
+        - 1
+        version: 0.8.1
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: redis
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 2
+        - 2
+        version: 2.2.2
+  type: :runtime
+  version_requirements: *id005
+description: See the github repo or examples.rb for usage information.
+email: 
+- kyle@keen.io
+executables: 
+- keen_send
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rvmrc
+- Gemfile
+- README.md
+- bin/keen_send
+- conf/cacert.pem
+- examples.rb
+- examples/rails_2/.rvmrc
+- examples/rails_2/CoolForums/README
+- examples/rails_2/CoolForums/Rakefile
+- examples/rails_2/CoolForums/app/controllers/application_controller.rb
+- examples/rails_2/CoolForums/app/controllers/forums_controller.rb
+- examples/rails_2/CoolForums/app/controllers/users_controller.rb
+- examples/rails_2/CoolForums/app/helpers/application_helper.rb
+- examples/rails_2/CoolForums/app/helpers/forums_helper.rb
+- examples/rails_2/CoolForums/app/helpers/users_helper.rb
+- examples/rails_2/CoolForums/app/models/forum.rb
+- examples/rails_2/CoolForums/app/models/user.rb
+- examples/rails_2/CoolForums/app/views/forums/edit.html.erb
+- examples/rails_2/CoolForums/app/views/forums/index.html.erb
+- examples/rails_2/CoolForums/app/views/forums/new.html.erb
+- examples/rails_2/CoolForums/app/views/forums/show.html.erb
+- examples/rails_2/CoolForums/app/views/layouts/forums.html.erb
+- examples/rails_2/CoolForums/app/views/layouts/users.html.erb
+- examples/rails_2/CoolForums/app/views/users/edit.html.erb
+- examples/rails_2/CoolForums/app/views/users/index.html.erb
+- examples/rails_2/CoolForums/app/views/users/new.html.erb
+- examples/rails_2/CoolForums/app/views/users/show.html.erb
+- examples/rails_2/CoolForums/config/boot.rb
+- examples/rails_2/CoolForums/config/database.yml
+- examples/rails_2/CoolForums/config/environment.rb
+- examples/rails_2/CoolForums/config/environments/development.rb
+- examples/rails_2/CoolForums/config/environments/production.rb
+- examples/rails_2/CoolForums/config/environments/test.rb
+- examples/rails_2/CoolForums/config/initializers/backtrace_silencers.rb
+- examples/rails_2/CoolForums/config/initializers/cookie_verification_secret.rb
+- examples/rails_2/CoolForums/config/initializers/inflections.rb
+- examples/rails_2/CoolForums/config/initializers/mime_types.rb
+- examples/rails_2/CoolForums/config/initializers/new_rails_defaults.rb
+- examples/rails_2/CoolForums/config/initializers/session_store.rb
+- examples/rails_2/CoolForums/config/locales/en.yml
+- examples/rails_2/CoolForums/config/routes.rb
+- examples/rails_2/CoolForums/db/migrate/20120317012301_create_users.rb
+- examples/rails_2/CoolForums/db/migrate/20120317012444_create_forums.rb
+- examples/rails_2/CoolForums/db/schema.rb
+- examples/rails_2/CoolForums/db/seeds.rb
+- examples/rails_2/CoolForums/doc/README_FOR_APP
+- examples/rails_2/CoolForums/public/404.html
+- examples/rails_2/CoolForums/public/422.html
+- examples/rails_2/CoolForums/public/500.html
+- examples/rails_2/CoolForums/public/favicon.ico
+- examples/rails_2/CoolForums/public/images/rails.png
+- examples/rails_2/CoolForums/public/index.html
+- examples/rails_2/CoolForums/public/javascripts/application.js
+- examples/rails_2/CoolForums/public/javascripts/controls.js
+- examples/rails_2/CoolForums/public/javascripts/dragdrop.js
+- examples/rails_2/CoolForums/public/javascripts/effects.js
+- examples/rails_2/CoolForums/public/javascripts/prototype.js
+- examples/rails_2/CoolForums/public/robots.txt
+- examples/rails_2/CoolForums/public/stylesheets/scaffold.css
+- examples/rails_2/CoolForums/script/about
+- examples/rails_2/CoolForums/script/console
+- examples/rails_2/CoolForums/script/dbconsole
+- examples/rails_2/CoolForums/script/destroy
+- examples/rails_2/CoolForums/script/generate
+- examples/rails_2/CoolForums/script/performance/benchmarker
+- examples/rails_2/CoolForums/script/performance/profiler
+- examples/rails_2/CoolForums/script/plugin
+- examples/rails_2/CoolForums/script/runner
+- examples/rails_2/CoolForums/script/server
+- examples/rails_2/CoolForums/test/fixtures/forums.yml
+- examples/rails_2/CoolForums/test/fixtures/users.yml
+- examples/rails_2/CoolForums/test/functional/forums_controller_test.rb
+- examples/rails_2/CoolForums/test/functional/users_controller_test.rb
+- examples/rails_2/CoolForums/test/performance/browsing_test.rb
+- examples/rails_2/CoolForums/test/test_helper.rb
+- examples/rails_2/CoolForums/test/unit/forum_test.rb
+- examples/rails_2/CoolForums/test/unit/helpers/forums_helper_test.rb
+- examples/rails_2/CoolForums/test/unit/helpers/users_helper_test.rb
+- examples/rails_2/CoolForums/test/unit/user_test.rb
+- examples/rails_2/Gemfile
+- keen.gemspec
+- lib/keen.rb
+- lib/keen/client.rb
+- lib/keen/storage/flat_file_handler.rb
+- lib/keen/storage/redis_handler.rb
+- lib/keen/version.rb
+- test/keen_spec.rb
+has_rdoc: true
+homepage: https://github.com/keenlabs/KeenClient-Ruby
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: keen
+rubygems_version: 1.4.2
+signing_key: 
+specification_version: 3
+summary: A library for sending events to the keen.io API.
+test_files: 
+- test/keen_spec.rb