pincode_finder 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 858a84640a57fedc687e52a9e1fa29e0f85a1b2de9b44096bd74232a8da015a5
-  data.tar.gz: 34450494e9a7e41b9beaf160f95041d90c3de16b3bf2cf183c4a15a2c25d6111
+  metadata.gz: 23b0acc58abe3487875681d61457003462b09264ea4b6044bf67f38e219c2fbd
+  data.tar.gz: 942ed9168f3635900da76105d98a41cf28e3c2a2be3c464ee72a52f7ef3754f5
 SHA512:
-  metadata.gz: 32b93766384dd4cbff6d6a77f7f0584205f560fed96cb8a59772910a0953cfd3ce167c9fa306010a3656129dc2082bdd213e2cb94e689e3e3937c8f08e4138b4
-  data.tar.gz: 15725e99cc9a852f23f75a90cc153bfa956ca881927489c464928b430435a3115ec5352014f0469a225b17aadd7c671cb77e6e5f377c8a92cda270ca023f154a
+  metadata.gz: 464841f577b1fe42a5668c0be326683b8c9c303152b349f893b3602ce92c935560e0b55f5e97fb77b395ac4ae5e3b03c3fd3597524b63740a1a4851c99897c87
+  data.tar.gz: ad92420da504249477cdb6e854ea8c206fcaa713f25cd4a9fdb489073a8c2d6a1249403a68b5fbc8edc06c8c067a9d2587e8b1a1f2943dd8eea9b3f1b502a356

data/lib/pincode_finder/config.rb

@@ -0,0 +1,19 @@
+module PincodeFinder
+  class Config
+    attr_accessor :github_owner, :github_repo, :github_token
+
+    def initialize
+      @github_owner = nil
+      @github_repo  = nil
+      @github_token = nil
+    end
+  end
+
+  def self.config
+    @config ||= Config.new
+  end
+
+  def self.configure
+    yield(config)
+  end
+end

data/lib/pincode_finder/github_client.rb

@@ -0,0 +1,64 @@
+require "net/http"
+require "uri"
+require "json"
+require "base64"
+
+module PincodeFinder
+  class GitHubClient
+    def initialize
+      @owner = PincodeFinder.config.github_owner
+      @repo  = PincodeFinder.config.github_repo
+      @token = PincodeFinder.config.github_token
+      @api = "https://api.github.com"
+      @file = "pincode_data_optimized.json.gz"
+    end
+
+    def get_file_with_sha
+      uri = URI("#{@api}/repos/#{@owner}/#{@repo}/contents/data/#{@file}")
+
+      req = Net::HTTP::Get.new(uri)
+      req["Authorization"] = "token #{@token}"
+      req["Accept"] = "application/vnd.github+json"
+
+      res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |h| h.request(req) }
+
+      return { json: {}, sha: nil } unless res.is_a?(Net::HTTPSuccess)
+
+      data = JSON.parse(res.body)
+      content = Base64.decode64(data["content"])
+
+      json_string = Zlib::GzipReader.new(StringIO.new(content)).read
+
+      { json: JSON.parse(json_string), sha: data["sha"] }
+    end
+
+    def update_file(json_data, sha)
+      json_string = JSON.pretty_generate(json_data)
+
+      # compress
+      string_io = StringIO.new
+      gz = Zlib::GzipWriter.new(string_io)
+      gz.write(json_string)
+      gz.close
+      compressed = string_io.string
+
+      encoded = Base64.strict_encode64(compressed)
+
+      uri = URI("#{@api}/repos/#{@owner}/#{@repo}/contents/data/#{@file}")
+
+      body = {
+        message: "Update #{@file}",
+        content: encoded,
+        sha: sha,
+        branch: "main"
+      }
+
+      req = Net::HTTP::Put.new(uri)
+      req["Authorization"] = "token #{@token}"
+      req["Accept"] = "application/vnd.github+json"
+      req.body = body.to_json
+
+      Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |h| h.request(req) }
+    end
+  end
+end

data/lib/pincode_finder/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PincodeFinder
-  VERSION = "0.1.2"
+  VERSION = "0.1.4"
 end

data/lib/pincode_finder.rb

@@ -1,26 +1,192 @@
-# frozen_string_literal: true
 require "json"
-require 'zlib'
-require_relative "pincode_finder/version"
+require "net/http"
+require "uri"
+require "fileutils"
+require "zlib"
+require "base64"
 
-module PincodeFinder
-  class Error < StandardError; end
-  data_file = File.expand_path('../data/pincode_data.json.gz', __dir__)
+require_relative "pincode_finder/config"
+require_relative "pincode_finder/github_client"
 
-  DATA = Zlib::GzipReader.open(data_file) do |gz|
-    JSON.parse(gz.read)
-  end
+module PincodeFinder
+  DATA_FILE = File.expand_path("../data/pincode_data_optimized.json.gz", __dir__)
+  DETAILS_HASH = "{ district: <district>, state: <state>}".freeze
 
   def self.find(pincode)
-    result = DATA.find { |entry| entry["pincode"].to_s == pincode.to_s }
-    if result
+    pincode = pincode.to_s
+    data = load_data
+
+    record = data[pincode]
+
+    if record
       {
-        pincode: result["pincode"],
-        district: result["district"],
-        state: result["state"]
+        pincode: pincode,
+        state: record["state"],
+        district: record["district"],
+        verified: record["verified"] || true
       }
     else
-      { error: "Pincode not found" }
+      {
+        error: "Pincode not found",
+        message: "You can add it using: PincodeFinder.add_pincode(#{pincode}, #{DETAILS_HASH})"
+      }
+    end
+  end
+
+  def self.add_pincode(pincode, input_details)
+    pincode = pincode.to_s
+    input_details = normalize_and_filter(input_details)
+
+    data = load_data
+    record = data[pincode]
+
+    return { status: "failure", error: "Pincode already present in the directory" } unless record.nil?
+
+    verified, error = validate_pincode(pincode, input_details)
+    return { status: "failure", error: error } unless error.nil?
+
+    data[pincode] = input_details.merge("verified" => verified)
+
+    save_data(data)
+
+    sync_to_github(data)
+
+    {
+      status: "success",
+      data: data[pincode],
+      error: nil
+    }
+  end
+
+  def self.validate_pincode(pincode, input_details)
+    verified, api_data = verify_pincode(pincode)
+    return [false, nil] unless verified
+
+    status, error = input_details_validation(api_data, input_details)
+    return [false, error] unless status
+
+    [verified, nil]
+  end
+
+  def self.verify_pincode(pincode)
+    begin
+      uri = URI("https://api.postalpincode.in/pincode/#{pincode}")
+
+      response = Net::HTTP.start(uri.host, uri.port, use_ssl: true,
+                                                     open_timeout: 3, read_timeout: 3) do |http|
+        http.get(uri.request_uri)
+      end
+
+      return [false, nil] unless response.is_a?(Net::HTTPSuccess)
+
+      json = JSON.parse(response.body) rescue nil
+      return [false, nil] unless json.is_a?(Array) && json[0].is_a?(Hash)
+
+      status = json[0]["Status"]
+      return [false, nil] unless status == "Success"
+
+      po = json[0]["PostOffice"]
+      return [false, nil] unless po.is_a?(Array) && po[0].is_a?(Hash)
+
+      details = po[0].slice("Division", "District", "State")
+
+      [true, details]
+    rescue StandardError
+      [false, nil]
+    end
+  end
+
+  def self.update_pincode(pincode, input_details)
+    pincode = pincode.to_s
+    input_details = normalize_and_filter(input_details)
+    data = load_data
+
+    record = data[pincode]
+    return { status: "failure", error: "pincode not found" } unless record
+
+    verified, error = validate_pincode(pincode, input_details)
+    return { status: "failure", error: error } unless error.nil?
+
+    data[pincode] = input_details.merge("verified" => verified)
+    save_data(data)
+    sync_to_github(data)
+
+    {
+      status: "success",
+      data: data[pincode],
+      error: nil
+    }
+  end
+
+  def self.delete_pincode(pincode)
+    pincode = pincode.to_s
+    data = load_data
+
+    record = data[pincode]
+    return { status: "failure", error: "pincode not found" } unless record
+
+    data.delete(pincode)
+
+    save_data(data)
+    sync_to_github(data)
+
+    {
+      status: "success",
+      data: {},
+      error: nil
+    }
+  end
+
+  def self.input_details_validation(data, input_details)
+    input_state     = input_details["state"].to_s.titleize
+    input_district  = input_details["district"].to_s.titleize
+
+    api_state       = data["State"].to_s.titleize
+    api_district    = data["District"].to_s.titleize
+    api_division    = data["Division"].to_s.titleize
+
+    return [false, "Incorrect state. Allowed: #{api_state}"] unless input_state == api_state
+
+    unless input_district == api_district || input_district == api_division
+      return [
+        false,
+        "Incorrect district. Allowed: #{api_district} or #{api_division}"
+      ]
+    end
+
+    [true, nil]
+  end
+
+  def self.load_data
+    Zlib::GzipReader.open(DATA_FILE) { |gz| JSON.parse(gz.read) }
+  end
+
+  def self.save_data(json)
+    json_string = JSON.pretty_generate(json)
+
+    Zlib::GzipWriter.open(DATA_FILE) do |gz|
+      gz.write(json_string)
+    end
+  end
+
+  def self.normalize_and_filter(input_details)
+    input_details
+      .transform_keys { |k| k.to_s.downcase }
+      .slice("district", "state")
+  end
+
+  def self.sync_to_github(data)
+    Thread.new do
+      begin
+        client = GitHubClient.new
+
+        remote = client.get_file_with_sha
+        sha    = remote[:sha]
+
+        client.update_file(data, sha)
+      rescue StandardError
+        nil
+      end
     end
   end
 end

metadata

@@ -1,15 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: pincode_finder
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Aadhi
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-28 00:00:00.000000000 Z
-dependencies: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: This gem takes a pincode as input and returns the associated district
   and state.
 email:
@@ -19,14 +32,16 @@ extensions: []
 extra_rdoc_files: []
 files:
 - data/pincode_data.json.gz
+- data/pincode_data_optimized.json.gz
 - lib/pincode_finder.rb
+- lib/pincode_finder/config.rb
+- lib/pincode_finder/github_client.rb
 - lib/pincode_finder/version.rb
 homepage: https://github.com/aadhi-flaerhomes/pincode_finder
 licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/aadhi-flaerhomes/pincode_finder
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -41,8 +56,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.10
-signing_key:
+rubygems_version: 3.7.2
 specification_version: 4
 summary: A gem to find Indian pincodes.
 test_files: []