wonderfl 0.1.0 → 0.2.0

data/README.rdoc

@@ -27,6 +27,12 @@ Create a wonderfl API client using your api_key as follows:
   client = Wonderfl::Client.new
   client.api_key = 'your api_key'
 
+if you want to cache the response from APIs
+
+  client = Wonderfl::Client.new('your api_key,
+                                :cache_file => 'cache.db',
+                                :expire => 60*10)
+
 You can then use that client to retrieve information about user or posted codes as so:
 
   client.get_user('user_name')  #=> Wonderfl::User

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/lib/wonderfl.rb

@@ -2,13 +2,14 @@ $:.unshift(File.dirname(__FILE__) + "/wonderfl/")
 
 require 'net/http'
 require 'time'
+require 'pstore'
 require 'rubygems'
 require 'json'
 
 Net::HTTP.version_1_2
 
 module Wonderfl
-  VERSION = '0.0.1'
+  VERSION = '0.2.0'
   BASE_URL = 'http://api.wonderfl.net'
   class BadRequest < StandardError; end
   class Unauthorized < StandardError; end

data/lib/wonderfl/client.rb

@@ -1,14 +1,15 @@
-module Wonderfl
 # The main client object through which the Wonderfl service may be accessed.
+module Wonderfl
   class Client
-    # api key
     attr_accessor :api_key
 
     # Requires api key, get yours from your account page
     # (wonderfl.net/account/api_keys/create)
     #
-    def initialize(api_key = nil)
+    def initialize(api_key = nil, options = {})
       @api_key = api_key
+      @cache = Wonderfl::Utils::Cache.new(options[:cache_file],
+                                          options[:expire])
     end
 
     # Returns a Wonderfl::User object detailing the user information.
@@ -16,7 +17,14 @@ module Wonderfl
     def get_user(user_name)
       _validate?(user_name)
       path = '/user/' + user_name
-      User.new(_request(path)[:body]['user'])
+      @cache.transaction do
+        data = @cache[path]
+        if data.nil?
+          @cache[path] = User.new(_request(path)[:body]['user'])
+        else
+          data          
+        end
+      end
     end
 
     # Returns a Wonderfl::UserCodes object (Wonderfl::Code collection)
@@ -25,7 +33,14 @@ module Wonderfl
     def get_user_codes(user_name)
       _validate?(user_name)
       path = '/user/' + user_name + '/codes'
-      UserCodes.new(_request(path)[:body]['codes'])
+      @cache.transaction do
+        data = @cache[path]
+        if data.nil?
+          @cache[path] = UserCodes.new(_request(path)[:body]['codes'])
+        else
+          data
+        end
+      end
     end
 
     # Returns a Wonderfl::Code object detailing the code information.
@@ -33,7 +48,14 @@ module Wonderfl
     def get_code(code_id)
       _validate?(code_id)
       path = '/code/' + code_id
-      Code.new(_request(path)[:body]['code'], code_id)
+      @cache.transaction do
+        data = @cache[path]
+        if data.nil?
+          @cache[path] = Code.new(_request(path)[:body]['code'], code_id)
+        else
+          data
+        end
+      end
     end
 
     # Returns a Wonderfl::CodeForks object (Wonderfl::Code collection)
@@ -42,10 +64,17 @@ module Wonderfl
     def get_code_forks(code_id)
       _validate?(code_id)
       path = '/code/' + code_id  + '/forks'
-      CodeForks.new(_request(path)[:body]['forks'])
+      @cache.transaction do
+        data = @cache[path]
+        if data.nil?
+          @cache[path] = CodeForks.new(_request(path)[:body]['forks'])
+        else
+          data
+        end
+      end
     end
 
-    # Sends HTTP request and returns a parsed JSON response
+    # Private methods.
     #
     private
     def _request(path)
@@ -70,8 +99,7 @@ module Wonderfl
       end
       { :code => response.code, :body => parsed }
     end
-    # Returns true, if argument is a String
-    #
+
     def _validate?(arg)
       return true if arg.is_a? String
       method_name = caller.first.scan(/`(.*)'/).to_s

data/lib/wonderfl/code.rb

@@ -1,6 +1,5 @@
 class Wonderfl::Code
   include Wonderfl::Utils
-
   attr_reader :thumbnail, :as3, :parent, :modified_date, :compile_ok,
               :created_date, :forked_count, :license, :swf, :diff,
               :user_icon, :user_name, :title, :id, :favorite_count

data/lib/wonderfl/utils.rb

@@ -10,4 +10,27 @@ module Wonderfl::Utils
   def parse_time(date)
     date ? Time.at(date) : nil
   end
+  # Caches response data from APIs
+  #
+  class Cache < PStore
+    def initialize(filename, expire)
+      @filename = filename || 'wonderfl_cache.db'
+      @expire = expire || 0
+      super(@filename)
+    end
+
+    def [](key)
+      value = super(key) || {}
+      expired = (value[:timestamp].nil? ||
+                 value[:timestamp] + @expire < Time.now)
+      expired ? nil : value[:entity]
+    end
+
+    def []=(key, value)
+      super(key, { 
+            :entity => value,
+            :timestamp => Time.now
+            })
+    end
+  end
 end

data/spec/test_client.rb

@@ -0,0 +1,50 @@
+#!/usr/bin/ruby
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+
+require 'wonderfl'
+
+begin
+  client = Wonderfl::Client.new('588b655bbd16a987675d0b574078659e55e6119c',
+  #                              :cache_file => 'a.db',
+                                :expire => 10)
+  #client = Wonderfl::Client.new
+  #client.api_key = '588b655bbd16a987675d0b574078659e55e6119c'
+  p client
+
+  puts "*** get_user ***\n"
+  user = client.get_user('nondelion')
+  puts user
+
+  puts "*** get_user_codes ***\n"
+  codes = client.get_user_codes('mari')
+  puts "codes count: " + codes.count.to_s
+  codes.each do |code|
+    puts code
+  end
+
+  puts "*** get_code ***\n"
+  code = client.get_code('4v7t')
+  puts code
+
+
+  puts "*** get_code_forks ***\n"
+  forks = client.get_code_forks('4v7t')
+  puts "forks count: " + forks.count.to_s
+  forks.each do |code|
+    puts code
+  end
+
+
+rescue Wonderfl::Unauthorized => e
+  puts 'Authentication Error: ' + e
+
+rescue Wonderfl::NotFound => e
+  puts 'NotFound Error: '+ e
+
+rescue Wonderfl::BadRequest => e
+  puts 'BadRequest Error: ' + e
+end
+
+include Wonderfl::Utils
+#puts dump('/user/mari/codes', '588b655bbd16a987675d0b574078659e55e6119c')

data/spec/wonderfl_spec.rb

@@ -2,7 +2,7 @@ require File.dirname(__FILE__) + '/spec_helper.rb'
 
 describe Wonderfl::Client do
   before do
-    @client = Wonderfl::Client.new
+    @client = Wonderfl::Client.new(nil, :expire => 0)
     @user_name = 'wellflat'
     @api_key = 'foo'
     @stub = WebMock.stub_request(:get, /http:\/\/api\.wonderfl\.net\/.*/)

data/wonderfl.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{wonderfl}
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["wellflat"]
-  s.date = %q{2010-08-16}
+  s.date = %q{2010-09-04}
   s.description = %q{Ruby wrapper for the wonderfl API. See README for more details.}
   s.email = %q{wellflat@gmail.com}
   s.extra_rdoc_files = [
@@ -46,6 +46,7 @@ Gem::Specification.new do |s|
   s.summary = %q{Ruby wrapper for the wonderfl API}
   s.test_files = [
     "spec/spec_helper.rb",
+     "spec/test_client.rb",
      "spec/wonderfl_spec.rb"
   ]
 

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - wellflat
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-16 00:00:00 +09:00
+date: 2010-09-04 00:00:00 +09:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -122,4 +122,5 @@ specification_version: 3
 summary: Ruby wrapper for the wonderfl API
 test_files: 
 - spec/spec_helper.rb
+- spec/test_client.rb
 - spec/wonderfl_spec.rb