sg_postcode 1.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3241ed35ffe07e0b40a10204bf2a7952131a5648
+  data.tar.gz: 3677670b8801efb86907e252b3923e4979872fe1
+SHA512:
+  metadata.gz: 42613712019d6d930c31cbbbf6dd5ebecd6c4b812dd2a11d032e1618ddbf2a5685c19ebf38cff753bb4c71e87ddf1851d26ad6c9f745abe7416c5b2c3f6424dd
+  data.tar.gz: b51d668090072588f13e2d6ea0102f17e18116fe8c5a5dd52ad44f188a8a206ecb1a2f726a9fc1b3007868d234269cbf75fb455013017de5daa9f76f2da817b9

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Duy Khoa
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,29 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SgPostcode'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/test_*.rb'
+  t.verbose = false
+  t.options = '--pride'
+end
+
+task default: :test

data/lib/sg_postcode.rb

@@ -0,0 +1,22 @@
+module SgPostcode
+end
+
+# Add these path to $LOAD_PATH
+#
+# so later, instead of writing
+#   require 'converters/json_ouput'
+# we can use
+#   require 'json_ouput'
+# cause the converters directory already in $LOAD_PATH
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "sg_postcode"))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "sg_postcode", "converters"))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "sg_postcode", "services"))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "sg_postcode", "response"))
+
+require "response"
+require "response_builder"
+require "json_output"
+require "config"
+require "array"
+require "google"
+require "long_lat_converter"

data/lib/sg_postcode/array.rb

@@ -0,0 +1,30 @@
+module SgPostcode
+  class Array
+    # Init a new array object
+    #
+    # @params
+    #   - postcodes: array[String] of postcode
+    #   - opts: hash of option
+    #     + response_type: default is :json, check the response folder
+    #     + host: :Google is default, check services folder
+    #
+    def initialize(postcodes, opts = {})
+      @postcodes = postcodes
+      @opts = opts
+    end
+
+    # Convert to a long lat array
+    #
+    # @return [{ long: '123456', lat: '123456' }, ...]
+    #
+    # @params
+    #   opts: list of options from #initializer
+    #
+    # @example
+    # SgPostcode::Array.new(postcodes).convert
+    #
+    def convert
+      LongLatConverter.new(@postcodes, @opts).convert
+    end
+  end
+end

data/lib/sg_postcode/converters/long_lat_converter.rb

@@ -0,0 +1,87 @@
+module SgPostcode
+  class LongLatConverter
+    attr_reader :postcodes
+
+    def initialize(postcodes, opts = {})
+      @postcodes = postcodes
+      convert_options opts
+    end
+
+    # Convert an array of SG Postcode
+    #
+    # @return an array contains long, lat
+    #
+    # @example
+    #  postcodes = ['238432', '247964']
+    #  SgPostCode::LongLatConverter.new(postcodes).convert
+    #
+    def convert
+      postcodes
+        .uniq(&:itself)
+        .map { |postcode| density_of(postcode, place_info(postcode)) }
+    end
+
+    # Request info from host for a postcode
+    #
+    # @return hash of info, check
+    #  response/config.rb to see the info fields
+    #
+    # @params: postcode number [String]
+    #
+    def place_info(postcode)
+      send_geo_request(postcode).data
+    end
+
+    # Send request to host, and return the response
+    #
+    # @return
+    #
+    # @params
+    #   postcode
+    #
+    # @example
+    # SgPostcode::LongLatConverter.send_geo_request("230000")
+    #
+    def send_geo_request(postcode)
+      return nil if Module.const_defined? @host
+
+      Response.new(
+        response(postcode),
+        response_type: :json
+      )
+    end
+
+    private
+
+    def response(postcode)
+      case @host
+      when :Google
+        Google.new(postcode).request
+      else
+        nil
+      end
+    end
+
+    def convert_options(opts)
+      @host = class_name(opts[:host]) || :Google
+      @response_type = opts[:response_type] || :json
+    end
+
+    def class_name(host)
+      return nil unless Module.constants.include? host
+      host.to_sym
+    end
+
+    def density_of(postcode, place_info_result)
+      place_info_result.merge density_info(postcode)
+    end
+
+    def density_info(postcode)
+      density_count(postcode) > 1 ? { density: density_count(postcode) } : {}
+    end
+
+    def density_count(postcode)
+      postcodes.count postcode
+    end
+  end
+end

data/lib/sg_postcode/response/config.rb

@@ -0,0 +1,34 @@
+module SgPostcode
+  module ResponseBuilder
+    class Config
+      class << self
+        # Get all response fields (key_paths)
+        def fields
+          @@fields ||= default_fields
+        end
+
+        # add a custom key_path
+        def add_key_path(key_name, *path)
+          #TODO
+        end
+
+        # remove a key_path
+        #
+        # @return nothing if keypath doesn't exist
+        #
+        def remove_key_path(key_name)
+          #TODO
+        end
+
+        # default fields (key_paths)
+        def default_fields
+          {
+            format_address: ['formatted_address'],
+            lat: ['geometry', 'location', 'lat'],
+            long: ['geometry', 'location', 'lng'],
+          }
+        end
+      end
+    end
+  end
+end

data/lib/sg_postcode/response/json_output.rb

@@ -0,0 +1,48 @@
+module SgPostcode
+  module ResponseBuilder
+    class JsonOutput < Builder
+      # Implement #data from Builder
+      #
+      # Combine all info fields in Config class to the result
+      def data
+        result = {}
+
+        Config.fields.each do |key, value|
+          result[key] = digg value
+        end
+
+        result
+      end
+
+      # Get value from a key path
+      #
+      # @params: key_path - array[String|integer]
+      #
+      # @return value of a keypath
+      #
+      # @example
+      #   @raw_data =
+      #     'results' => [
+      #      {
+      #        'address' => [
+      #          {
+      #           'short_name' => '1'
+      #          }
+      #        ]
+      #      }
+      #     ]
+      #
+      #    so the key_path will be
+      #    keypath = ['address', 0, 'short_name']
+      #
+      #    response = SgPostcode::ResponseBuilder::JsonOutput.new(@raw_data)
+      #    response.data
+      #
+      def digg(key_path)
+        key_path.inject(@raw_data) do |result, key|
+          (result.respond_to?(:[]) && (result[key] || {})) || break
+        end
+      end
+    end
+  end
+end

data/lib/sg_postcode/response/response.rb

@@ -0,0 +1,22 @@
+require 'json'
+
+module SgPostcode
+  class Response
+    def initialize(raw_data, response_type: :json)
+      @raw_data = JSON.parse(raw_data)
+      @response_type = response_type
+    end
+
+    # build the data hash
+    # may use Builder object to contruct the output data
+    #
+    def data
+      case @response_type
+      when :json
+        ResponseBuilder::JsonOutput.new(@raw_data).data
+      else
+        nil
+      end
+    end
+  end
+end

data/lib/sg_postcode/response/response_builder.rb

@@ -0,0 +1,21 @@
+module SgPostcode
+  module ResponseBuilder
+    class Builder
+      attr_reader :raw_data
+      # Initialize a new builder
+      #
+      # All subclass of Builder will inherit this method
+      #
+      # raw_data must have the 'results', follow is an array
+      def initialize(raw_data)
+        # FIXME: check if the data is invalid
+        @raw_data = raw_data['results'].first rescue nil
+      end
+
+      # Implement this method in the subclass instead
+      def data
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/sg_postcode/services/google.rb

@@ -0,0 +1,22 @@
+require 'rest-client'
+
+module SgPostcode
+  class Google
+    # Request URL
+    REQUEST_SERVICE_URL = 'https://maps.googleapis.com/maps/api/geocode/json'
+
+    def initialize(postcode)
+      @postcode = postcode
+    end
+
+    # Send Request with the postcode included as a params
+    #
+    # @example
+    #   sender = SgPostcode:Google.new('238432')
+    #   sender.request
+    #
+    def request
+      RestClient.get REQUEST_SERVICE_URL, { params: { address: @postcode } }
+    end
+  end
+end

data/lib/sg_postcode/version.rb

@@ -0,0 +1,3 @@
+module SgPostcode
+  VERSION = "1.1.1"
+end

data/lib/tasks/sg_postcode_tasks.rake

@@ -0,0 +1,5 @@
+# desc "Explaining what the task does"
+# task :sg_postcode do
+#   # Task goes here
+# end
+#

data/test/converters/test_long_lat_converter.rb

@@ -0,0 +1,17 @@
+require 'test_helper'
+
+class TestLongLatConverter < Minitest::Test
+  def setup
+    @converter = SgPostcode::LongLatConverter.new(nil)
+  end
+
+  def test_send_request
+    @converter.place_info(nil)
+  end
+
+  def test_send_geo_request
+    result = @converter.send_geo_request("23000")
+
+    refute_equal nil, result
+  end
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .