cyprus-postal-codes 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0d732be91129396dfeefde4cc7f9ca7ec86344a658acc284c40e5f33bb20b019
+  data.tar.gz: e278f18084a4f29be83cedca09f9d09bb6a8128494689bb8f485862105044c1b
+SHA512:
+  metadata.gz: '0483cce51cdcb5569b4e01ee9d8b585887493d925141ce91ad0a25cdfb95a7a57203ff751002f0d1df634b715d7f15332b1af47f6eed710901cd0c4db21df4ce'
+  data.tar.gz: a165dd76795f8f907a9e49645b0b5d55e2936f06096c8ac7a01f7843d3cabd59cf508a4b1f1afab988647ecf52f40bb6e71478992683a0a970942bf007764bd2

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,27 @@
+require:
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.7
+
+RSpec/NestedGroups:
+  Max: 4
+
+Style/Documentation:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+# be a bit kinder with our metrics
+Metrics/BlockLength:
+  IgnoredMethods: ['describe', 'context']
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-01-22
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at e.giataganas@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in cyprus-postal-codes.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"
+gem "rubocop-rake"
+gem "rubocop-rspec"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Evangelos Giataganas
+
+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/README.md

@@ -0,0 +1,189 @@
+# Cyprus Postal Codes API Rubygem
+
+[![Build Status](https://github.com/DigitalAppsCY/cyprus-postal-codes/workflows/CI/badge.svg)](https://github.com/DigitalAppsCY/cyprus-postal-codes/actions)
+
+![logo](cyprus_postal_codes.png)
+
+The easiest and most complete rubygem for [CYPRUS POST: POSTAL CODES API](https://documenter.getpostman.com/view/6477303/RztmtUjG).
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Usage](#usage)
+- [Resources](#resources)
+  - [Addresses](#addresses)
+  - [Districts](#districts)
+  - [Areas](#areas)
+  - [Search](#search)
+  - [Government Services](#government-Services)
+  - [Post Office Boxes](#post-office-boxes)
+  - [Parcel 24 Locations](#parcel-24-locations)
+  - [Occupied Areas](#occupied-areas)
+- [Development](#development)
+- [Contributing](#contributing)
+- [License](#license)
+- [Code of Conduct](#code-of-conduct)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cyprus-postal-codes'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```    
+
+Or install it yourself as:
+
+```bash
+$ gem install cyprus-postal-codes
+```
+
+And access the library in Ruby:
+
+```ruby
+require 'cyprus-postal-codes'
+```
+
+## Usage
+
+To access the API, you'll need to create a `CyprusPostalCodes::Client` and pass in your API key. You can use [Cyprus Post](https://www.cypruspost.post/en/contact) contact form to request your API key.
+
+The API is multi-language. has `lng` param on each resources. It can either be `el` which will return the response in greek or `en` which will return the response in english.
+
+### The client will default to the greek
+
+```ruby
+client = CyprusPostalCodes::Client.new(api_key: ENV["CYPRUS_POSTAL_CODES_API_KEY"])
+```
+
+### The client will use english
+
+```ruby
+client = CyprusPostalCodes::Client.new(api_key: ENV["CYPRUS_POSTAL_CODES_API_KEY"], lng: "en")
+```
+
+The client then gives you access to each of the resources.
+
+## Resources
+
+The gem maps as closely as we can to the Cyprus Postal Codes API so you can easily convert API examples to gem code.
+
+Responses are returned as `Hash`.
+
+### Addresses
+
+Retrieve the addresses or P.O.Boxes within selected post code.
+
+Required parameter:
+- `post_code`, must be 4 characters
+
+```ruby
+client.addresses(post_code: 1017)
+```
+
+### Districts
+
+Retrieve districts where post code search can be applied.
+
+```ruby
+client.districts
+```
+
+### Areas
+
+Retrieve areas in selected district.
+
+Required parameter
+- `district`, available districts can be found calling [district](#districts)
+
+```ruby
+client.areas(district: "lefkosia")
+```
+
+### Search
+
+Retrieves addresses filtered by the parameter.
+
+Required parameter:
+- `param`, must be at least 3 characters with characters contained in street name
+- `district`, available districts can be found calling [district](#districts)
+
+Optional parameter:
+- `areas`, areas can be found calling [areas](#areas)
+
+```ruby
+client.search(district: "lefkosia", param: "arc")
+```
+
+### Government Services
+
+Retrieve government authorities' information with param be contained in name. In order to filter locations by their district, you can fill district parameter with param attribute.
+
+Required parameter:
+- `param`, must be at least 3 characters with characters contained in name
+
+Optional parameter:
+- `district`, available districts can be found calling [district](#districts)
+
+```ruby
+client.government_services(param: "arc")
+```
+
+### Post Office Boxes
+
+Retrieve post office box's information with selected number.
+
+Required parameter:
+- `number`, must be at least 5 characters
+
+```ruby
+client.post_office_boxes(number: 12220)
+```
+
+### Parcel 24 Locations
+
+Retrieve Parcel24 location's information with param be contained in name. In order to filter locations by their district, you can fill district parameter with param attribute.
+
+Optional parameter:
+- `param`, must be at least 3 characters with characters contained in name
+- `district`, available districts can be found calling [district](#districts)
+
+```ruby
+client.parcel24_locations
+```
+
+### Occupied Areas
+
+Retrieve addresses of occupied area in selected district with param be contained in street name. In order to filter locations by their district, you can fill district parameter with param attribute.
+
+Optional parameter:
+- `param`, characters contained in street name
+- `district`, available districts can be found calling [district](#districts)
+
+```ruby
+client.occupied_areas
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/cyprus-postal-codes. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/cyprus-postal-codes/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the CyprusPostalCodes project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/cyprus-postal-codes/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[rubocop spec]

data/lib/cyprus_postal_codes/client/addresses.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module CyprusPostalCodes
+  class Client
+    module Addresses
+      def addresses(post_code:, page_token: nil)
+        get("addresses", postal_code: post_code, page_token: page_token)
+      end
+    end
+  end
+end

data/lib/cyprus_postal_codes/client/areas.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module CyprusPostalCodes
+  class Client
+    module Areas
+      def areas(district:, page_token: nil)
+        get("get-areas", district: district, page_token: page_token)
+      end
+    end
+  end
+end

data/lib/cyprus_postal_codes/client/districts.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module CyprusPostalCodes
+  class Client
+    module Districts
+      def districts
+        get("district-selection")
+      end
+    end
+  end
+end

data/lib/cyprus_postal_codes/client/government_services.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module CyprusPostalCodes
+  class Client
+    module GovernmentServices
+      def government_services(param:, district: nil, page_token: nil)
+        get("government-services", param: param, district: district, page_token: page_token)
+      end
+    end
+  end
+end

data/lib/cyprus_postal_codes/client/occupied_areas.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module CyprusPostalCodes
+  class Client
+    module OccupiedAreas
+      def occupied_areas(district: nil, param: nil, page_token: nil)
+        get("occupied-areas", district: district, param: param, page_token: page_token)
+      end
+    end
+  end
+end

data/lib/cyprus_postal_codes/client/paginator.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module CyprusPostalCodes
+  class Client
+    module Paginator
+      RESOURCES = %w[addresses result].freeze
+      private_constant :RESOURCES
+
+      def next_page
+        paginator&.dig("tokens", "next_page")
+      end
+
+      def previous_page
+        paginator&.dig("tokens", "previous_page")
+      end
+
+      def first_page
+        paginator&.dig("tokens", "first_page")
+      end
+
+      def last_page
+        paginator&.dig("tokens", "last_page")
+      end
+
+      def total_pages
+        paginator&.fetch("total_pages") || 0
+      end
+
+      def total_count
+        paginator&.fetch("total_count") || 0
+      end
+
+      private
+
+      def paginator
+        @paginator = last_response&.body&.dig("data", resource&.join, "paginator")
+      end
+
+      def resource
+        last_response&.body&.dig("data")&.keys & RESOURCES
+      end
+    end
+  end
+end

data/lib/cyprus_postal_codes/client/parcel24_locations.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module CyprusPostalCodes
+  class Client
+    module Parcel24Locations
+      def parcel24_locations(district: nil, param: nil, page_token: nil)
+        get("parcel24-locations", district: district, param: param, page_token: page_token)
+      end
+    end
+  end
+end

data/lib/cyprus_postal_codes/client/post_office_boxes.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module CyprusPostalCodes
+  class Client
+    module PostOfficeBoxes
+      def post_office_boxes(number:, page_token: nil)
+        get("post-office-boxes", number: number, page_token: page_token)
+      end
+    end
+  end
+end

data/lib/cyprus_postal_codes/client/search.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module CyprusPostalCodes
+  class Client
+    module Search
+      def search(district:, param:, area: nil, page_token: nil)
+        get("search", district: district, param: param, area: area, page_token: page_token)
+      end
+    end
+  end
+end

data/lib/cyprus_postal_codes/client.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "faraday_middleware"
+
+module CyprusPostalCodes
+  class Client
+    include Addresses
+    include Areas
+    include Districts
+    include GovernmentServices
+    include OccupiedAreas
+    include Paginator
+    include Parcel24Locations
+    include PostOfficeBoxes
+    include Search
+
+    BASE_URL = "https://cypruspost.post/api/postal-codes/"
+    private_constant :BASE_URL
+
+    def initialize(api_key:, lng: "el")
+      @api_key = api_key
+      @lng = lng
+    end
+
+    def get(resource, options = {})
+      @last_response = connection.get(resource, options.merge(default_params))
+      @last_response.body["data"]
+    end
+
+    def last_response
+      @last_response if defined?(@last_response)
+    end
+
+    private
+
+    attr_reader :api_key, :lng
+
+    def default_params
+      { lng: lng }
+    end
+
+    def connection
+      @connection ||= Faraday.new do |conn|
+        conn.url_prefix = BASE_URL
+        conn.headers["Authorization"] = api_key
+        conn.adapter Faraday.default_adapter
+        conn.request :json
+        conn.response :json, content_type: "application/json"
+      end
+    end
+  end
+end

data/lib/cyprus_postal_codes/error.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module CyprusPostalCodes
+  class Error < StandardError; end
+end

data/lib/cyprus_postal_codes/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module CyprusPostalCodes
+  VERSION = "0.1.0"
+end

data/lib/cyprus_postal_codes.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative "cyprus_postal_codes/version"
+
+module CyprusPostalCodes
+  autoload :Addresses, "cyprus_postal_codes/client/addresses"
+  autoload :Areas, "cyprus_postal_codes/client/areas"
+  autoload :Client, "cyprus_postal_codes/client"
+  autoload :Districts, "cyprus_postal_codes/client/districts"
+  autoload :Error, "cyprus_postal_codes/error"
+  autoload :GovernmentServices, "cyprus_postal_codes/client/government_services"
+  autoload :OccupiedAreas, "cyprus_postal_codes/client/occupied_areas"
+  autoload :Paginator, "cyprus_postal_codes/client/paginator"
+  autoload :Parcel24Locations, "cyprus_postal_codes/client/parcel24_locations"
+  autoload :PostOfficeBoxes, "cyprus_postal_codes/client/post_office_boxes"
+  autoload :Search, "cyprus_postal_codes/client/search"
+end

data/sig/cyprus_postal_codes/cyprus_postal_codes.rbs

@@ -0,0 +1,4 @@
+module CyprusPostalCodes
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: cyprus-postal-codes
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Evangelos Giataganas
+- Despo Pentara
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-02-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: 'A gem for using the CyprusPost: Postal Codes API (https://documenter.getpostman.com/view/6477303/RztmtUjG)'
+email:
+- evangelos@digitalapps.io
+- despo@extractmethod.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cyprus_postal_codes.png
+- lib/cyprus_postal_codes.rb
+- lib/cyprus_postal_codes/client.rb
+- lib/cyprus_postal_codes/client/addresses.rb
+- lib/cyprus_postal_codes/client/areas.rb
+- lib/cyprus_postal_codes/client/districts.rb
+- lib/cyprus_postal_codes/client/government_services.rb
+- lib/cyprus_postal_codes/client/occupied_areas.rb
+- lib/cyprus_postal_codes/client/paginator.rb
+- lib/cyprus_postal_codes/client/parcel24_locations.rb
+- lib/cyprus_postal_codes/client/post_office_boxes.rb
+- lib/cyprus_postal_codes/client/search.rb
+- lib/cyprus_postal_codes/error.rb
+- lib/cyprus_postal_codes/version.rb
+- sig/cyprus_postal_codes/cyprus_postal_codes.rbs
+homepage: https://github.com/EGiataganas/cyprus-postal-codes
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/EGiataganas/cyprus-postal-codes
+  source_code_uri: https://github.com/EGiataganas/cyprus-postal-codes
+  changelog_uri: https://github.com/EGiataganas/cyprus-postal-codes/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: 'A gem for using the CyprusPost: Postal Codes API'
+test_files: []