octoevent 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Peng Sun
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+Software), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED AS IS, WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,4 @@
+OctoEvent
+=========
+
+Fetches the events of Github at your command.

data/lib/OctoEvent.rb

@@ -0,0 +1,118 @@
+require 'httpclient'
+require 'json'
+require_relative 'helper'
+
+class OctoEvent
+  GITHUB_EVENT_API_END_POINT = "https://api.github.com/%s/events"
+
+  attr_accessor :config_url
+  attr_accessor :parsing_block
+  attr_accessor :target_array
+  attr_accessor :client_id
+  attr_accessor :client_secret
+  attr_accessor :etag_hash
+  attr_accessor :last_event_hash
+  attr_accessor :sleep_period
+
+  def initialize *args, &block
+    @etag_hash = Hash.new ""         # a hash for etags
+    @last_event_hash = Hash.new ""   # a hash for last event
+
+    @sleep_period = 1
+
+    case args.size
+    when 1
+      # Using a remote url to serve as the config json
+      # Benefits? We can dynamiclly change it!
+      # Also needs to pass in a block that does what it takes to trim the json
+      @clnt = HTTPClient.new
+      @config_url = args[0]
+      @parsing_block = block
+    when 3
+      # For a single target who shell never change, just provide it with github login & type
+      name, type, etag = args
+      @config_url = nil
+      path = path_for name, type
+      target_array << path
+      @etag_hash[path] = etag
+    end
+  end
+
+  def github_key_pair client_id, client_secret
+    @client_id = client_id
+    @client_secret = client_secret
+  end
+
+  def to_s
+    "Grab events for #{target_array}"
+  end
+
+  def target_array
+    @target_array ||= []
+  end
+
+  def grab event_types, &block
+    raise "nothing to do if there's no block" unless block
+
+    acceptable_events = event_types.parse_event_types
+    while true # this is a worker dyno
+      update_target if @config_url
+
+      result = {}
+      target_array.each do |target|
+        events = events_for target, acceptable_events
+        result[target] = events unless events.empty?
+      end
+
+      block.call result unless result.empty? # send the result to client unless it's empty
+
+      sleep sleep_period
+    end
+  end
+
+  private
+  # Composed path for github
+  def path_for name, type
+    "#{type}s/#{name}"
+  end
+
+  # Use json as config to make the users dynamiclly changable
+  def update_target
+    obj = JSON.load(@clnt.get(@config_url).body) || []
+    obj = @parsing_block.call(obj) if @parsing_block
+
+    obj.each do |target|
+      name = target["name"]
+      type = target["type"]
+      target_array << "#{type}s/#{name}"
+    end
+  end
+
+  # Get events for a single target
+  def events_for target, event_types
+    url = GITHUB_EVENT_API_END_POINT % target
+    etag = @etag_hash[target]
+    last_event = @last_event_hash[target]
+
+    events_to_send = []
+    page = 1
+    while page <= 10
+      result = @clnt.get(url, {client_id: @client_id, client_secret: @client_secret}, {"If-None-Match" => etag})
+      break unless result.status_code == 200
+      events = JSON.load result.body
+      if page == 1 # etag and last event should be set when querying the very first page
+        @etag_hash[target] = result.header["etag"]
+        @last_event_hash[target] = events[0]
+      end
+
+      events.each do |event|
+        return events_to_send if last_event == event # no need to proceed
+        events_to_send << event if event_types.accept? event
+      end
+
+      page += 1
+    end
+
+    events_to_send
+  end
+end

data/lib/helper.rb

@@ -0,0 +1,17 @@
+# Helper methods
+
+# Mixin helper to parse the accpetable strings
+class String
+  def parse_event_types
+    self.split(",").map {|str| "#{str.strip.capitalize}Event"}
+  end
+end
+
+# Mixin helper to test if we should accept this event
+class Array
+  def accept? event
+    return true if self.include? "AllEvent"
+    return false unless event.has_key? "type"
+    self.include? event["type"]
+  end
+end

data/lib/storage.rb

@@ -0,0 +1,10 @@
+# Providing a universal API for different storages
+
+class Storage
+end
+
+class CouchDBStorage < Storage
+end
+
+class LocalFSStorage < Storage
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: octoevent
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Peng Sun
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httpclient
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.3
+description: ! '  Grab activity events for you from Octocat
+
+'
+email: voidmain1313113@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- LICENSE
+- lib/helper.rb
+- lib/OctoEvent.rb
+- lib/storage.rb
+homepage: https://github.com/void-main/OctoEvent
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Grab activity events for you from Octocat
+test_files: []