sg_postcode 1.2.4 → 1.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2f4118ecad2beea98b1d9e829ea23057cc977fbd
-  data.tar.gz: fb464a6cb0b27e34c5b761fefe3317723a6b9823
+  metadata.gz: 16852417b548612f8e74f646ec0378b9d1c8d517
+  data.tar.gz: e48309bd857ebcc8af595ca9f53121380ca5fbac
 SHA512:
-  metadata.gz: 96387514afa3093f69f802c97e22853884faa2ef60418397705ffd28921e23f2de2771250586d5908752674386c795f3bceb7fe31d8118dd6b039dbcab12c229
-  data.tar.gz: df96d35738fa3514ee5c4b21b4b0d3c3a8cda985d417f670c4869af056c0ac0325e357c5dbb9a34b111ef199969ea0a3427314203dd19ec576edad1d8ffd3bff
+  metadata.gz: 82301d3a01f5933f75f593ec15a33a083ef811f9e47f4bee4b7b355aa2016255250dfa0f8461323fe660f5d270fa6896c873261cd06fccc55735283d0b481eb7
+  data.tar.gz: 624b8918f53cc4b3eeb25a87e8a47d65510a1e841c9994a4f4774cdde4e131fdb6941d2bd879c99fab3d350f3168500bbf0ffc133399254fb4d9a8284ca7d6ba

data/lib/sg_postcode/converters/long_lat_converter.rb

@@ -43,9 +43,6 @@ module SgPostcode
     # SgPostcode::LongLatConverter.send_geo_request("230000")
     #
     def send_geo_request(postcode)
-      # FIXME: not sure
-      return nil if Module.const_defined? @host
-
       Response.new(
         response(postcode),
         response_type: :json
@@ -55,16 +52,16 @@ module SgPostcode
     private
 
     def response(postcode)
-      Proxy.new(@host, postcode, cache: true).request
+      Proxy.new(@host, postcode, cache: @cache).request
     end
 
     def convert_options(opts)
       @host = class_name(opts[:host]) || :Google
       @response_type = opts[:response_type] || :json
+      @cache = opts[:cache].nil? ? true : opts[:cache]
     end
 
     def class_name(host)
-      # FIXME: not sure
       return nil unless Module.constants.include? host
       host.to_sym
     end

data/lib/sg_postcode/response/config.rb

@@ -9,7 +9,7 @@ module SgPostcode
 
         # add a custom key_path
         def add_key_path(key_name, *path)
-          #TODO
+          fields.merge!({ key_name => path })
         end
 
         # remove a key_path
@@ -17,7 +17,7 @@ module SgPostcode
         # @return nothing if keypath doesn't exist
         #
         def remove_key_path(key_name)
-          #TODO
+          fields.delete(key_name)
         end
 
         # default fields (key_paths)

data/lib/sg_postcode/services/cache_adapter.rb

@@ -2,24 +2,50 @@ module SgPostcode
   class CacheAdapter
     @@hash_name = "SgPostcodeCaching"
 
+    # Init a new CacheAdapter object
+    #
+    # @dependencies: redis
+    #
+    # Redis.new will get REDIS_URL as host
+    # you can customize it by set value for
+    # `ENV["REDIS_URL"]`
+    #
+    # @params
+    #   @cache
+    #   @key in this context is a postcode
+    #
     def initialize(key)
       @cache = Redis.new
       @key = key
     end
 
+    # Redefine @@hash_name (key_name in Redis hash store)
+    #
+    # @example
+    #   SgPostcode::CacheAdapter.hash_name = "test_redis_store"
+    #
     def self.hash_name=(hash_name)
       @@hash_name = hash_name
     end
 
+    # Fetch request data from cache
+    #
+    # TODO: will split #value_of method to sub-class
+    # cause Adapter shouldn't call Redis directly
+    #
     def fetch
       value_of @key
     end
 
+    # Store new postcode and request_data to Redis
+    #
     def store(key, value)
       @cache.hset(@@hash_name, key, value)
       value
     end
 
+    # Get Value of a postcode from Redis Hash Store
+    #
     def value_of(key)
       @cache.hget(@@hash_name, key)
     end

data/lib/sg_postcode/services/proxy.rb

@@ -14,9 +14,13 @@ module SgPostcode
     end
 
     def request
-      return nil unless service && cache_adapter
+      return nil unless service
 
-      cache_adapter.fetch || cache_adapter.store(@postcode, service.request)
+      if cache_adapter
+        cache_adapter.fetch || cache_adapter.store(@postcode, service.request)
+      else
+        service.request
+      end
     end
   end
 end

data/lib/sg_postcode/version.rb

@@ -1,3 +1,3 @@
 module SgPostcode
-  VERSION = "1.2.4"
+  VERSION = "1.2.5"
 end

data/test/response/test_config.rb

@@ -0,0 +1,29 @@
+require 'test_helper'
+
+class TestConfig < Minitest::Test
+  def setup
+    SgPostcode::ResponseBuilder::Config.class_variable_set :@@fields, SgPostcode::ResponseBuilder::Config.default_fields
+  end
+
+  def test_default_fields
+    assert_equal 3, SgPostcode::ResponseBuilder::Config.fields.keys.count
+  end
+
+  def add_key
+    SgPostcode::ResponseBuilder::Config.add_key_path(:test, 'first', 'second')
+  end
+
+  def test_add_key_path
+    add_key
+    assert_equal 4, SgPostcode::ResponseBuilder::Config.fields.keys.count
+    assert_operator SgPostcode::ResponseBuilder::Config.fields.keys, :include?, :test
+  end
+
+  def test_remove_key_path
+    add_key
+
+    SgPostcode::ResponseBuilder::Config.remove_key_path :test
+
+    assert_equal false, SgPostcode::ResponseBuilder::Config.fields.keys.include?(:test)
+  end
+end

data/test/services/test_proxy.rb

@@ -54,4 +54,15 @@ class TestProxy < Minitest::Test
       assert_equal true, proxy.request
     end
   end
+
+  def test_non_cached
+    nocache_proxy = SgPostcode::Proxy.new(:Google, "238432", cache: false)
+
+    mock = Minitest::Mock.new
+    mock.expect :request, "Send Request"
+
+    nocache_proxy.stub :service, mock do
+      assert_equal "Send Request", nocache_proxy.request
+    end
+  end
 end

data/test/test_sg_postcode.rb

@@ -1,6 +1,10 @@
 require 'test_helper'
 
 class TestSgPostcode < Minitest::Test
+  def setup
+    Redis.new.flushall
+  end
+
   def test_init_new_sg_postcode_array
     postcode_array = SgPostcode::Array.new([])
     assert_kind_of SgPostcode::Array, postcode_array
@@ -62,4 +66,14 @@ class TestSgPostcode < Minitest::Test
     convert = SgPostcode::Array.new(['238438'], host: :Google)
     assert_kind_of Array, convert.convert
   end
+
+  def test_non_cached
+    converter = SgPostcode::Array.new(['238432'], cache: false)
+    converter.convert
+
+    redis = Redis.new
+    store = SgPostcode::CacheAdapter.class_variable_get :@@hash_name
+
+    assert_equal 0, redis.hkeys(store).length
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sg_postcode
 version: !ruby/object:Gem::Version
-  version: 1.2.4
+  version: 1.2.5
 platform: ruby
 authors:
 - Duy Khoa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-24 00:00:00.000000000 Z
+date: 2015-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -46,6 +46,7 @@ files:
 - lib/sg_postcode/version.rb
 - lib/tasks/sg_postcode_tasks.rake
 - test/converters/test_long_lat_converter.rb
+- test/response/test_config.rb
 - test/response/test_json_output.rb
 - test/response/test_response_builder.rb
 - test/sample_response.json
@@ -79,6 +80,7 @@ specification_version: 4
 summary: Convert SG Postcode to long lat array
 test_files:
 - test/converters/test_long_lat_converter.rb
+- test/response/test_config.rb
 - test/response/test_json_output.rb
 - test/response/test_response_builder.rb
 - test/sample_response.json