kanoko 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e42bf64558cec67348c3f8b2793079179c5012c1
-  data.tar.gz: 6148e4976c50a71236ffe7c1ab8b5b2860f438e1
+  metadata.gz: 174aaa5dc844a02ce0fe1bc7d99aabddffbc8db5
+  data.tar.gz: b78fe145753b4104900984eccc76d7259da3922e
 SHA512:
-  metadata.gz: 3246a4f831cb4355b0f200e52ef608f5c04a79228a7498c225fbb66efb1aed28dac8a74d5de6fe7ba13bb305848935cfe79c94c4637f8cff994223af2d77d25d
-  data.tar.gz: ab2dc0dc148d7a1637b5d6d3ca581b067f68c98778c466d2bb94148a99e7290ae2167ae10e3116887a44d3b0a0db8502a77120ec3daac46bf18dd24b9b1661b2
+  metadata.gz: 3d980fb390493a82e79718a41054486272b9e0390bf6a963e877c4fbe92aada2fd197d3f74045cd80d5a6352383f94109db67d328c53a8f15f49ffdc5dbbbdc8
+  data.tar.gz: ae4bc45b643ae3f19233377b242c497bfa7bd27366f2fcb2ecf3b4319809a20ff24aa21605336271404b2f1b399ef1bfb468a0748258e9b5b720ac4b2800489d

data/README.md

@@ -2,3 +2,52 @@ kanoko
 ===
 
 [![Build Status](https://travis-ci.org/spice-life/kanoko.svg?branch=master)](https://travis-ci.org/spice-life/kanoko)
+
+**kanoko** is an active image generate application.
+
+# Quick Start
+
+```
+require 'kanoko/application/convert'
+
+class MyApp < Kanoko::Application::Convert
+end
+
+run MyApp
+```
+
+```
+$ KANOKO_DIGEST_FUNC=sha1 KANOKO_SECRET_KEY=devkey unicorn --config-file config/unicorn/development.rb
+```
+
+# Arguments
+
+**http://{{kanoko.host}}/:hash/:func/:args/:path**
+
+- **hash:** params signature (see also **Signature**)
+- **func:** a function name of image processing (e.g. fit)
+- **args:** image processing arguments (e.g. "100x100")
+- **path:** Target image path without scheme (e.g. "host/path/to/image?params\_a=value\_a")
+
+# Signature
+
+**hash** is changeable.
+
+By default, see `Kanoko::Configure#initialize`.
+
+On application, It must be set **hash** same way as this.
+
+If hash not match, application should be return *400 Bad Request*.
+
+This function behavior can change by Kanoko.configure.
+
+```ruby
+Kanoko.configure.hash_proc = ->{
+  "some_hash_value_on_url"
+}
+```
+
+# TODO
+
+- To be able to change digest_func and secret_key on graceful restart
+- More fast

data/lib/kanoko.rb

@@ -3,7 +3,7 @@ require 'kanoko/configure'
 
 module Kanoko
   # example:
-  #   Kanoko.configure.kanoko_host = "http://example.com"
+  #   Kanoko.configure.digest_func = "sha1"
   #   p Kanoko.configure #=> #<Kanoko::Configure ...>
   def configure
     @configure ||= Configure.new
@@ -19,24 +19,14 @@ module Kanoko
     @configure = value
   end
 
-  def url_for(func, args, src)
-    if configure.kanoko_host.nil?
-      fail ConfigureError, "`kanoko_host' must be set"
-    end
-    "#{configure.kanoko_host}#{make_path(func, args, src)}"
+  def path_for(func, args, src)
+    hash = make_hash(func, args, src)
+    "/#{hash}/#{[func, args].map{|i| URI.encode_www_form_component(i)}.join('/')}/#{src}"
   end
-  module_function :url_for
+  module_function :path_for
 
   def make_hash(*args)
     configure.hash_proc.call(*args)
   end
   module_function :make_hash
-
-  private
-
-  def make_path(func, args, src)
-    hash = make_hash(func, args, src)
-    "/#{hash}/#{[func, args].map{|i| URI.encode_www_form_component(i)}.join('/')}/#{src}"
-  end
-  module_function :make_path
 end

data/lib/kanoko/application/convert.rb

@@ -3,7 +3,7 @@ require 'net/http'
 require 'tempfile'
 require 'kanoko'
 
-# This is a experimental implementation.
+# This is an experimental implementation.
 # You can set configure and other.
 # This application receve url make by Kanoko.url_for().
 # You can choice function that image processing.

data/lib/kanoko/configure.rb

@@ -6,20 +6,17 @@ module Kanoko
   class Configure
     attr_accessor :digest_func, :secret_key, :hash_proc
 
-    # kanoko_host expect String
     # digest_func expect String
     # secret_key expect String
     # hash_proc expect Proc
     #
     # example:
     #   Kanoko.configure do |c|
-    #     c.kanoko_host = "http://example.com"
     #     c.digest_func = "sha1"
     #     c.secret_key = "secret"
     #   end
-    #   Kanoko.url_for(:resize, "100x100") #=> "http://example.com/.../.../..."
+    #   Kanoko.path_for(:resize, "100x100") #=> "/hashing_value/resize/100x100"
     def initialize
-      @kanoko_host = nil
       @digest_func = ENV['KANOKO_DIGEST_FUNC']
       @secret_key = ENV['KANOKO_SECRET_KEY']
       @hash_proc = ->(*args){
@@ -33,28 +30,5 @@ module Kanoko
         )
       }
     end
-
-    def kanoko_host=(host)
-      @kanoko_host = normalize_url(host)
-    end
-
-    def kanoko_host
-      @kanoko_host
-    end
-
-    private
-
-    def normalize_url(host)
-      case host
-      when %r{\Ahttps?://}
-        host
-      when %r{\A[^/]}
-        "http://#{host}"
-      when %r{\A//}
-        "http:#{host}"
-      else
-        fail ConfigureError, "invalid kanoko_host `#{host}'"
-      end
-    end
   end
 end

data/lib/kanoko/version.rb

@@ -1,3 +1,3 @@
 module Kanoko
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/test/test_configure.rb

@@ -6,19 +6,6 @@ class TestKanokoConfigure < Minitest::Test
     @config = Kanoko::Configure.new
   end
 
-  def test_kanoko_host
-    assert_raises(Kanoko::ConfigureError) { @config.kanoko_host = "/example.com" }
-
-    @config.kanoko_host = "example.com"
-    assert_equal "http://example.com", @config.kanoko_host
-
-    @config.kanoko_host = "http://example.com"
-    assert_equal "http://example.com", @config.kanoko_host
-
-    @config.kanoko_host = "https://example.com"
-    assert_equal "https://example.com", @config.kanoko_host
-  end
-
   def test_hash_proc_by_default_error
     @config.digest_func = nil
     @config.secret_key = nil

data/test/test_kanoko.rb

@@ -5,7 +5,6 @@ class TestKanoko < Minitest::Test
   def setup
     Kanoko.configure.digest_func = "sha1"
     Kanoko.configure.secret_key = "test"
-    Kanoko.configure.kanoko_host = "http://example.com"
   end
 
   def change_hash_proc(hash_proc)
@@ -25,10 +24,10 @@ class TestKanoko < Minitest::Test
     assert_equal "ok", Kanoko.configure.digest_func
   end
 
-  def test_url_for_with_default_hash_proc
+  def test_path_for_with_default_hash_proc
     change_hash_proc(proc{ "aaa" }) do
-      assert_equal "http://example.com/aaa/test_func/test_args/test_path", Kanoko.url_for(:test_func, "test_args", "test_path")
-      assert_equal "http://example.com/aaa/test_func/%2F%3F-_%3D%21%40%23%3C%3E%5C//?-_=!@#<>\\", Kanoko.url_for(:test_func, "/?-_=!@#<>\\", "/?-_=!@#<>\\")
+      assert_equal "/aaa/test_func/test_args/test_path", Kanoko.path_for(:test_func, "test_args", "test_path")
+      assert_equal "/aaa/test_func/%2F%3F-_%3D%21%40%23%3C%3E%5C//?-_=!@#<>\\", Kanoko.path_for(:test_func, "/?-_=!@#<>\\", "/?-_=!@#<>\\")
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kanoko
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - ksss