resterl 0.0.1 → 0.0.2

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 fduetsch
+Copyright (c) 2010 Nix-wie-weg Reisen GmbH & Co. KG
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -1,6 +1,7 @@
 = resterl
 
-Description goes here.
+resterl is a rudimentary HTTP client with focus on caching.
+Please consider this library as beta, see TODO.rdoc for open issues.
 
 == Note on Patches/Pull Requests
  
@@ -9,9 +10,10 @@ Description goes here.
 * Add tests for it. This is important so I don't break it in a
   future version unintentionally.
 * Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
+  (if you want to have your own version, that is fine but bump version in a commit
+  by itself I can ignore when I pull)
+* Send us a pull request. Bonus points for topic branches.
 
 == Copyright
 
-Copyright (c) 2010 fduetsch. See LICENSE for details.
+Copyright (c) 2010 Nix-wie-weg Reisen GmbH & Co. KG. See LICENSE for details.

data/Rakefile

@@ -5,20 +5,19 @@ require 'rake'
 begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20
+    # for additional settings
+
     gem.name = "resterl"
     gem.summary = %Q{Rudimentary HTTP client with focus on caching}
-    gem.description = %Q{Rudimentary HTTP client with focus on caching}
+    # TODO Prio 2
+    #gem.description = %Q{}
     gem.email = "florian.duetsch@nix-wie-weg.de"
-    gem.homepage = "http://nix-wie-weg.de/"
+    gem.homepage = "http://github.com/Nix-wie-weg/resterl"
     gem.authors = ["Florian Dütsch"]
 
-    # TODO
-    #gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
-    
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20
-    # for additional settings
-
-    # TODO: Können wir auf einen neuere Version gehen?
+    # Dependencies
+    gem.add_development_dependency 'shoulda'
     gem.add_dependency 'hashie', '~> 0.4.0'
     gem.add_dependency 'yajl-ruby', '~> 0.7.7'
   end

data/{TODO → TODO.rdoc}

@@ -1,5 +1,7 @@
 * Edit README.rdoc
+* Tests!
 * Use technoweenie's faraday as base (http://github.com/technoweenie/faraday)
 * Secure caching with tests
 * Store parsed objects in cache (instead of the plain response)
 * Persistent connections
+* Documentation

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/lib/resterl.rb

@@ -3,104 +3,22 @@ require 'net/https'
 require 'yajl/json_gem'
 ################################################################################
 module Resterl; end
+module Resterl::Caches; end
 ################################################################################
-#require 'resterl/class_level_inheritable_attributes'
-require 'resterl/cache_interface'
-require 'resterl/redis_cache'
-require 'resterl/simple_cache'
+require 'resterl/class_level_inheritable_attributes'
+
+# Caches
+require 'resterl/caches/cache_interface'
+require 'resterl/caches/redis_cache'
+require 'resterl/caches/simple_cache'
+require 'resterl/caches/rails_memcached_cache'
+require 'resterl/caches/key_prefix_decorator'
+
 require 'resterl/client'
 require 'resterl/request'
 require 'resterl/response'
 require 'resterl/base_object'
+
 ################################################################################
 Net::HTTP.version_1_1
 ################################################################################
-
-# TODOs Prio 2:
-# * Nach Möglichkeit unsere Bibliothek auf Basis von Faraday
-# * Caching mit Tests absichern
-# * Objekte auch in den Cache? Ja, im Idealfall nur die Objekte
-# * Komplettes User-Framework
-# * Memoization
-# * Eigener Client?
-# * Cookie mit remember-Token?
-# * Persistente Verbindungen
-
-# TODOs ID-Service-Integration
-# * Anforderungen in Kunden-DB-2 prüfen
-#   * Zentrale Frage: Fallback-Lösung notwendig?
-#   * Eher zweiten ID-Server?
-
-
-# Composition-Pattern?
-
-
-=begin
-Beispiel Kunden-DB:
-
-User-Model
-* Holt prename, email, wiki_name
-* Hat in der Tabelle login
-* Merkt sich den User über ein remember_token in einem Cookie
-
-Zusätzlich lib/authenticated_system.rb
-
-=end
-
-
-
-
-=begin
-http://www.slideshare.net/pengwynn/json-and-the-apinauts
-
-Transports
-
-Net::HTTP
-Patron      http://toland.github.com/patron/
-Typhoeus    http://github.com/pauldix/typhoeus
-em-http-request   http://github.com/igrigorik/em-http-request
-
-Parsers
-
-Crack       http://github.com/jnunemaker/crack
-yajl-ruby   http://github.com/brainmario/yajl-ruby
-multi_json  http://github.com/intridea/multi_json
-
-
-Higher Level Libs
-
-HTTParty      http://github.com/jnunemaker/httparty
-monster_mash  http://github.com/dbalatero/monster_mash
-RestClient    http://github.com/adamwiggins/rest-client
-Weary         http://github.com/mwunsch/weary
-RackClient    http://github.com/halorgium/rack-client
-Faraday       http://github.com/technoweenie/faraday
-Faraday Middleware  http://github.com/pengwynn/faraday-middleware
-
-
-Tools
-
-Hashie
-hurl
-HTTPScoop
-Charles Proxy
-
-
-
-url = 'http://api.twitter.com/1'
-conn = Faraday::Connection.new(:url => url ) do |builder|
-  builder.adapter Faraday.default_adapter
-  builder.use Faraday::Response::MultiJson
-  builder.use Faraday::Response::Mashify
-end
-
-resp = conn.get do |req|
-  req.url '/users/show.json', :screen_name => 'pengwynn'
-end
-
-u = resp.body
-u.name
-# => "Wynn Netherland"
-
-
-=end

data/lib/resterl/base_object.rb

@@ -2,8 +2,10 @@ require 'hashie'
 
 class Resterl::BaseObject #< Hashie::Mash
 
-  class_inheritable_accessor :resterl_client, :parser, :complete_mime_type,
-                             :mapper
+  include ClassLevelInheritableAttributes
+  inheritable_attributes :resterl_client, :parser, :complete_mime_type,
+                         :mapper
+
   #self.resterl_client = nil
   #self.complete_mime_type = 'text/plain'
 

data/lib/resterl/{cache_interface.rb → caches/cache_interface.rb}

@@ -1,4 +1,4 @@
-class Resterl::CacheInterface
+class Resterl::Caches::CacheInterface
   def read key
     raise 'Not yet implemented!'
   end

data/lib/resterl/caches/key_prefix_decorator.rb

@@ -0,0 +1,21 @@
+class Resterl::Caches::KeyPrefixDecorator < Resterl::Caches::CacheInterface
+  def initialize cache, key_prefix
+    @cache = cache
+    @key_prefix = key_prefix
+  end
+  def read key
+    @cache.read key_ext(key)
+  end
+  def write key, value, expires_in
+    @cache.write key_ext(key), value, expires_in
+  end
+  def delete key
+    @cache.delete key_ext(key)
+  end
+
+  private
+
+  def key_ext key
+    "#{@key_prefix}#{key}"
+  end
+end

data/lib/resterl/caches/rails_memcached_cache.rb

@@ -0,0 +1,14 @@
+require 'forwardable'
+class Resterl::Caches::RailsMemcachedCache < Resterl::Caches::CacheInterface
+  extend Forwardable
+
+  def initialize client
+    @client = client
+  end
+
+  def_delegators :@client, :read, :delete
+
+  def write key, value, expires_in
+    @client.write key, value, :expires_in => expires_in
+  end
+end

data/lib/resterl/{redis_cache.rb → caches/redis_cache.rb}

@@ -1,4 +1,4 @@
-class Resterl::RedisCache < Resterl::CacheInterface
+class Resterl::Caches::RedisCache < Resterl::Caches::CacheInterface
 
   def initialize client
     @client = client

data/lib/resterl/{simple_cache.rb → caches/simple_cache.rb}

@@ -1,7 +1,7 @@
 # From:
 # http://github.com/der-flo/localmemcache_store/blob/master/lib/expiry_cache.rb
 
-class Resterl::SimpleCache < Resterl::CacheInterface
+class Resterl::Caches::SimpleCache < Resterl::Caches::CacheInterface
 
   class Entry < Struct.new(:data, :expires_at)
     def expired?

data/lib/resterl/class_level_inheritable_attributes.rb

@@ -0,0 +1,28 @@
+# From:
+# http://railstips.org/blog/archives/2006/11/18/class-and-instance-variables-in-ruby/
+module ClassLevelInheritableAttributes
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  module ClassMethods
+    def inheritable_attributes(*args)
+      @inheritable_attributes ||= [:inheritable_attributes]
+      @inheritable_attributes += args
+      args.each do |arg|
+        class_eval %(
+          class << self; attr_accessor :#{arg} end
+        )
+      end
+      @inheritable_attributes
+    end
+
+    def inherited(subclass)
+      @inheritable_attributes.each do |inheritable_attribute|
+        instance_var = "@#{inheritable_attribute}"
+        subclass.instance_variable_set(instance_var,
+                                       instance_variable_get(instance_var))
+      end
+    end
+  end
+end

data/lib/resterl/client.rb

@@ -2,7 +2,7 @@ class Resterl::Client
   attr_reader :options
   DEFAULTS = {
     :max_redirect_depth => 10,
-    :cache => Resterl::SimpleCache.new,
+    :cache => Resterl::Caches::SimpleCache.new,
     :ssl_verify_mode => OpenSSL::SSL::VERIFY_NONE,
     :expiry_multiplier => 10,
     :minimum_cache_lifetime => 5 * 60 # 5 Minuten

data/resterl.gemspec

@@ -5,17 +5,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{resterl}
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Florian Dütsch"]
-  s.date = %q{2010-09-29}
-  s.description = %q{Rudimentary HTTP client with focus on caching}
+  s.date = %q{2010-09-30}
   s.email = %q{florian.duetsch@nix-wie-weg.de}
   s.extra_rdoc_files = [
     "LICENSE",
-     "README.rdoc",
-     "TODO"
+     "README.rdoc"
   ]
   s.files = [
     ".document",
@@ -23,21 +21,24 @@ Gem::Specification.new do |s|
      "LICENSE",
      "README.rdoc",
      "Rakefile",
-     "TODO",
+     "TODO.rdoc",
      "VERSION",
      "lib/resterl.rb",
      "lib/resterl/base_object.rb",
-     "lib/resterl/cache_interface.rb",
+     "lib/resterl/caches/cache_interface.rb",
+     "lib/resterl/caches/key_prefix_decorator.rb",
+     "lib/resterl/caches/rails_memcached_cache.rb",
+     "lib/resterl/caches/redis_cache.rb",
+     "lib/resterl/caches/simple_cache.rb",
+     "lib/resterl/class_level_inheritable_attributes.rb",
      "lib/resterl/client.rb",
-     "lib/resterl/redis_cache.rb",
      "lib/resterl/request.rb",
      "lib/resterl/response.rb",
-     "lib/resterl/simple_cache.rb",
      "resterl.gemspec",
      "test/helper.rb",
      "test/test_resterl.rb"
   ]
-  s.homepage = %q{http://nix-wie-weg.de/}
+  s.homepage = %q{http://github.com/Nix-wie-weg/resterl}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.7}
@@ -52,13 +53,16 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
       s.add_runtime_dependency(%q<hashie>, ["~> 0.4.0"])
       s.add_runtime_dependency(%q<yajl-ruby>, ["~> 0.7.7"])
     else
+      s.add_dependency(%q<shoulda>, [">= 0"])
       s.add_dependency(%q<hashie>, ["~> 0.4.0"])
       s.add_dependency(%q<yajl-ruby>, ["~> 0.7.7"])
     end
   else
+    s.add_dependency(%q<shoulda>, [">= 0"])
     s.add_dependency(%q<hashie>, ["~> 0.4.0"])
     s.add_dependency(%q<yajl-ruby>, ["~> 0.7.7"])
   end

data/test/test_resterl.rb

@@ -1,7 +1,19 @@
 require 'helper'
 
 class TestResterl < Test::Unit::TestCase
-  should "probably rename this file and start testing for real" do
-    flunk "hey buddy, you should probably rename this file and start testing for real"
+
+  should 'load successfully' do
+    dummy = nil
+    cache = Resterl::Caches::KeyPrefixDecorator.new(
+      Resterl::Caches::RailsMemcachedCache.new(dummy),
+      'prefix_'
+    )
+
+
+    ODIN_CLIENT = Resterl::Client.new(
+      :base_uri => 'http://www.google.com/',
+      :cache => cache
+    )
   end
+
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - "Florian D\xC3\xBCtsch"
@@ -14,13 +14,26 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-29 00:00:00 +02:00
+date: 2010-09-30 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: hashie
+  name: shoulda
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: hashie
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -31,11 +44,11 @@ dependencies:
         - 0
         version: 0.4.0
   type: :runtime
-  version_requirements: *id001
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: yajl-ruby
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -46,8 +59,8 @@ dependencies:
         - 7
         version: 0.7.7
   type: :runtime
-  version_requirements: *id002
-description: Rudimentary HTTP client with focus on caching
+  version_requirements: *id003
+description: 
 email: florian.duetsch@nix-wie-weg.de
 executables: []
 
@@ -56,28 +69,30 @@ extensions: []
 extra_rdoc_files: 
 - LICENSE
 - README.rdoc
-- TODO
 files: 
 - .document
 - .gitignore
 - LICENSE
 - README.rdoc
 - Rakefile
-- TODO
+- TODO.rdoc
 - VERSION
 - lib/resterl.rb
 - lib/resterl/base_object.rb
-- lib/resterl/cache_interface.rb
+- lib/resterl/caches/cache_interface.rb
+- lib/resterl/caches/key_prefix_decorator.rb
+- lib/resterl/caches/rails_memcached_cache.rb
+- lib/resterl/caches/redis_cache.rb
+- lib/resterl/caches/simple_cache.rb
+- lib/resterl/class_level_inheritable_attributes.rb
 - lib/resterl/client.rb
-- lib/resterl/redis_cache.rb
 - lib/resterl/request.rb
 - lib/resterl/response.rb
-- lib/resterl/simple_cache.rb
 - resterl.gemspec
 - test/helper.rb
 - test/test_resterl.rb
 has_rdoc: true
-homepage: http://nix-wie-weg.de/
+homepage: http://github.com/Nix-wie-weg/resterl
 licenses: []
 
 post_install_message: