brocktail 0.0.1 → 0.0.2

data/README

@@ -0,0 +1,10 @@
+Ruby wrapper for Blocktail API v1 - your number one festival guide
+
+
+TODO:
+
+* specs ("Oh Ivan! you should've write specs first..." - I know :) )
+* Endpoint for Act
+* Endpoint for Venue
+* Endpoint for User
+* Deep (nested) JSON parsing

data/brocktail.gemspec

@@ -12,7 +12,11 @@ Gem::Specification.new do |s|
   s.summary     = %q{Brocktail is a Ruby wrapper for Blocktail API v1}
   s.description = %q{Brocktail is a Ruby wrapper for Blocktail API v1}
 
-  s.add_development_dependency "typhoeus"
+  s.add_dependency "typhoeus"
+  s.add_dependency "crack"
+  s.add_dependency "activesupport"
+  s.add_dependency "i18n"
+  
 
   s.rubyforge_project = "brocktail"
 

data/lib/brocktail.rb

@@ -1,13 +1,17 @@
 require 'typhoeus'
-require 'json'
 require 'base64'
+require 'crack'
+require 'active_support/all'
 
-require 'brocktail/errors'
-require 'brocktail/credentials'
-require 'brocktail/behavior/crud'
+require File.dirname(__FILE__) + '/brocktail/version'
+require File.dirname(__FILE__) + '/brocktail/credentials'
+require File.dirname(__FILE__) + '/brocktail/errors'
+require File.dirname(__FILE__) + '/brocktail/behavior/crud'
 
+require File.dirname(__FILE__) + '/brocktail/base'
 
-require 'brocktail/base'
+%w(base_model event act).each { |f| require File.dirname(__FILE__) + "/brocktail/#{f}" }
+%w(base events acts).each { |f| require File.dirname(__FILE__) + "/brocktail/api/#{f}" }
 
 module Brocktail
   

data/lib/brocktail/act.rb

@@ -0,0 +1,19 @@
+module Brocktail
+  class Act < BaseModel
+    
+    api_path "/acts"
+    
+    attr_accessor :id,              # Integer
+                  :event_id,        # Integer
+                  :item_id,         # Integer
+                  :venue_id,        # Integer
+                  :day_number,      # Integer
+                  :starttime,       # Date
+                  :duration,        # Integer
+                  :attendees_count, # Integer
+                  :created_at,      # DateTime
+                  :updated_at,      # DateTime
+                  :item             # Object
+    
+  end
+end

data/lib/brocktail/api/acts.rb

@@ -0,0 +1,22 @@
+module Brocktail
+  module API
+    class Acts < Base
+      api_model Brocktail::Act
+      
+      include Brocktail::Behavior::Crud
+      
+      attr_reader :event_id
+      
+      def initialize(credentials, event_id)
+        @event_id = event_id
+        super(credentials)
+      end
+      
+      def all
+        response = request(:get, credentials, "#{Brocktail::Event.api_path}/#{@event_id}/#{api_model.api_path}")
+        api_model.parse(response.body)
+      end
+            
+    end
+  end
+end

data/lib/brocktail/api/base.rb

@@ -0,0 +1,45 @@
+module Brocktail
+  module API
+    class Base
+      attr_reader :credentials
+      
+      def initialize(credentials)
+        @credentials = credentials
+      end
+      
+      class << self
+        def api_model(klass)
+          class_eval <<-END
+            def api_model
+              #{klass}
+            end
+          END
+        end
+      end
+      
+      
+      protected #-------------------------------------------------------------|
+      
+      def request(method, credentials, path, options = {})
+        request = Typhoeus::Request.new("#{credentials.host}#{path}")
+        
+        hydra = Typhoeus::Hydra.new
+        hydra.queue(request)
+        hydra.run
+
+        response = request.response
+
+        case response.code
+          when 200..201 then response
+          when 400 then raise Brocktail::BadRequest.new(response)
+          when 404 then raise Brocktail::NotFound.new(response)
+          when 500 then raise Brocktail::ServerError.new(response)
+          when 502 then raise Brocktail::Unavailable.new(response)
+          when 503 then raise Brocktail::RateLimited.new(response)
+          else raise Brocktail::InformBrocktail.new(response)
+        end
+      end
+      
+    end
+  end
+end

data/lib/brocktail/api/events.rb

@@ -0,0 +1,10 @@
+module Brocktail
+  module API
+    class Events < Base
+      api_model Brocktail::Event
+      
+      include Brocktail::Behavior::Crud
+      
+    end
+  end
+end

data/lib/brocktail/base.rb

@@ -0,0 +1,22 @@
+module Brocktail
+  class Base
+    
+    attr_reader :request, :credentials
+    
+    def initialize(username, password, options = {})
+      options[:ssl] = true if options[:ssl].nil?
+      @credentials = Credentials.new(username, password, options[:ssl])
+      raise InvalidCredentials unless credentials.valid?
+    end
+    
+    
+    def events
+      @events ||= Brocktail::API::Events.new(credentials)
+    end
+    
+    def acts(event_id)
+      @events ||= Brocktail::API::Acts.new(credentials, event_id)
+    end
+    
+  end
+end

data/lib/brocktail/base_model.rb

@@ -0,0 +1,51 @@
+module Brocktail
+  class BaseModel
+    
+    def initialize(attributes = {})
+      self.attributes = attributes
+    end
+    
+    def attributes=(attributes)
+      attributes.each { |k,v| send("#{k}=", v)}
+    end
+    
+    def ==(other)
+      id == other.id
+    end
+    
+    def to_i
+      id
+    end
+    
+    def to_json
+      # TODO
+    end
+    
+    def self.parse(json, options = {})
+      options[:resource] ||= self.name.split('::').last.downcase
+      puts options
+      
+      if options[:singular]
+        return self.new(Crack::JSON.parse(json)[options[:resource].to_s])
+      else
+        resources = []
+        
+        # Rails 3 way: Arrayified objects
+        # [{"object":{...}}, {"object":{...}}, ..., {"object":{...}}]
+        Crack::JSON.parse(json).each { |obj| resources << self.new(obj[options[:resource].to_s]) }
+        
+        # Rails old way: Rooted JSON
+        # {"objects":[{...}, {...}, ..., {...}]}
+        # Crack::JSON.parse(json)[options[:resource].to_s.pluralize].each { |attrs| resources << self.new(attrs) }
+        return resources
+      end
+    end
+    
+    class << self
+      def api_path(path = nil)
+        @path ||= path
+      end
+    end
+    
+  end
+end

data/lib/brocktail/behavior/crud.rb

@@ -0,0 +1,29 @@
+module Brocktail
+  module Behavior
+    module Crud
+      
+      def all
+        response = request(:get, credentials, api_model.api_path)
+        api_model.parse(response.body)
+      end
+      
+      def find(id)
+        response = request(:get, credentials, "#{api_model.api_path}/#{id}")
+        api_model.parse(response.body, :singular => true)
+      end
+      
+      # def create(model)
+      #   
+      # end
+      # 
+      # def update(model)
+      #   
+      # end
+      # 
+      # def delete(model)
+      #   
+      # end
+      
+    end
+  end
+end

data/lib/brocktail/credentials.rb

@@ -0,0 +1,23 @@
+module Brocktail
+  class Credentials
+    
+    attr_accessor :username, :password, :ssl
+    
+    def initialize(username, password, ssl = true)
+      @username, @password, @ssl = username, password, ssl
+    end
+    
+    def valid?
+      !username.nil? && !password.nil?
+    end
+    
+    def basic_auth
+      Base64.encode64("#{username}:#{password}").delete("\r\n")
+    end
+    
+    def host
+      "#{ssl ? "https" : "http"}://blocktail.heroku.com/api/v1"
+    end
+    
+  end
+end

data/lib/brocktail/errors.rb

@@ -0,0 +1,26 @@
+module Brocktail
+  
+  class InvalidCredentials < StandardError; end
+  
+  class HTTPError < StandardError
+    attr_reader :response
+    
+    def initialize(response)
+      @response = response
+      super
+    end
+    
+    def to_s
+      hint = response.headers["hint"].nil? ? nil : response.headers["hint"].first
+      "#{self.class.to_s} : #{response.code}#{" - #{hint}" if hint}"
+    end
+  end
+  
+  class RateLimited < HTTPError; end
+  class NotFound < HTTPError; end
+  class Unavailable < HTTPError; end
+  class InformHarvest < HTTPError; end
+  class BadRequest < HTTPError; end
+  class ServerError < HTTPError; end
+  
+end

data/lib/brocktail/event.rb

@@ -0,0 +1,24 @@
+module Brocktail
+  class Event < BaseModel
+    
+    api_path "/events"
+    
+    attr_accessor :id,              # Integer
+                  :name,            # String
+                  :slug,            # String
+                  :introduction,    # Text
+                  :description,     # Text
+                  :startdate,       # Date
+                  :number_of_days,  # Integer
+                  :attendees_count, # Integer
+                  :acts_count,      # Integer
+                  :address,         # String
+                  :zip,             # String
+                  :locality,        # String
+                  :state,           # String
+                  :country,         # String
+                  :created_at,      # DateTime
+                  :updated_at       # DateTime
+    
+  end
+end

data/lib/brocktail/version.rb

@@ -1,3 +1,3 @@
 module Brocktail
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: brocktail
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Ivan Malijkh
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-01 00:00:00 +02:00
+date: 2011-04-02 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -30,8 +30,50 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :development
+  type: :runtime
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: crack
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: i18n
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
 description: Brocktail is a Ruby wrapper for Blocktail API v1
 email: 
 - ivan@lesslines.com
@@ -44,9 +86,20 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - Gemfile
+- README
 - Rakefile
 - brocktail.gemspec
 - lib/brocktail.rb
+- lib/brocktail/act.rb
+- lib/brocktail/api/acts.rb
+- lib/brocktail/api/base.rb
+- lib/brocktail/api/events.rb
+- lib/brocktail/base.rb
+- lib/brocktail/base_model.rb
+- lib/brocktail/behavior/crud.rb
+- lib/brocktail/credentials.rb
+- lib/brocktail/errors.rb
+- lib/brocktail/event.rb
 - lib/brocktail/version.rb
 has_rdoc: true
 homepage: ""