geo_ppp 0.1.4 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2597eeb4b44aea702a71741374dff570adf042a3a7f3887e51fc2cd38decb2b7
-  data.tar.gz: cccd7bcc8a6b0d94e1e57eb42ac537c21ff4d832161e99bc84ae66a927b59f66
+  metadata.gz: 11aca1821df7a6983f1bde1f3280cf79c9992cda2d0e5969a7d9974b8563c704
+  data.tar.gz: '0972f1da32af3b6d6c0f79429f5684d245e0d5308a1fe3813837bedbc8d6123f'
 SHA512:
-  metadata.gz: '00558f17d0aacc6bb4c5ba2296a76e4018ae4a941f9ed106ed2bdac5ab295e40773e9144df9be8b8afd9c8a07059053959603983489a608c11326462a54536b0'
-  data.tar.gz: f86da527a35b8cc53f80a2e44bb4bacf1a3602cb63e818c0bffd3a641ed0632803b161ea534a0b0364cab71c6ddd155610a979592be3bc4c2bbb1dabd51bdcb9
+  metadata.gz: 93b74ef9317a47a14cfc5a7e1d5caa3f5bb1f2810c1c66c0130ae2391be3745a0ec4f5c70fdd716b86b2edc6a9432fb5b5445a7eade62fee47ca4f2ed51db29b
+  data.tar.gz: a643c92d4b2ebc8cc4312ecc06953183fd5a98ccebff8b1b4414a93acfce453d06ca3175cd35db474ccef5a81f613fce9597f4fe44d90caa25b03d30526df40b

data/README.md

@@ -1,34 +1,58 @@
-# GeoPpp
+# Geo Purchasing Power Parity
 
-TODO: Delete this and the text below, and describe your gem
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/geo_ppp`. To experiment with that code, run `bin/console` for an interactive prompt.
+Sell your digital products at purchasing power parity for based on users country. Not everyone is able to pay for the default pricing of the high income world. Cup of Coffee in Colombia or Indonesia cost less than USA or Australia, apply same principal to your digital products and get more customers. This package is inspired by `purchasing-power-parity` npm and uses their API.
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
-Install the gem and add to the application's Gemfile by executing:
+Add this line to your application's Gemfile
+```bash
+gem 'geo_ppp'
+```
 
+and run bundle
 ```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+bundle install
 ```
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
 ```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+gem install geo_pp
 ```
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+GeoPPPFetcher.fetch
+```
+will get the purchasing power parity data based on user's IP address.
+
+```ruby
+GeoPPPFetcher.fetch('LK')
+```
+will get the purchasing power parity data based on country code provided.
 
-## Development
+Both above will return a following json structure, you could use ```pppConversionFactor``` to convert it price based on user's geographic location
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+```ruby
+{"countryCodeIsoAlpha2":"LK","countryCodeIsoAlpha3":"LKA","currenciesCountry":{"LKR":{"symbol":"Rs  රු","name":"Sri Lankan rupee"}},"currencyMain":{"exchangeRate":300.701498,"name":"USD","symbol":"$"},"ppp":10040.0,"pppConversionFactor":0.33}
+```
+
+```ruby
+def index
+  original_price = 79.99
+
+  begin
+    response = GeoPPPFetcher.fetch
+	 discounted_price = original_price * response['pppConversionFactor']
+	 data = { original_price: original_price, discounted_price: discounted_price }
+	 render json: { success: true, data: data }
+  rescue StandardError => e
+    render json: { success: false, error: e.message }, status: :unprocessable_entity
+  end
+end
+```
 
-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
 
@@ -40,4 +64,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the GeoPpp project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/geo_ppp/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the geo_ppp project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/geo_ppp/blob/master/CODE_OF_CONDUCT.md).

data/lib/geo_ppp/fetcher.rb

@@ -3,11 +3,16 @@ require 'json'
 
 class GeoPPPFetcher
   GEO_API_URL = 'https://freegeoip.app/json/'.freeze
-  PPP_API_URL = 'https://api.purchasing-power-parity.com/?target='.freeze
-
-  def self.fetch
-	 geo = fetch_geo
-	 fetch_ppp(geo)
+	# https://api.purchasing-power-parity.com/?target=ID redirects to https://ppp-api.fly.dev/?target=ID and then results are returned
+  PPP_API_URL = 'https://ppp-api.fly.dev/?target='.freeze
+
+  def self.fetch(country_code = nil)
+		geo = if country_code.nil?
+			fetch_geo
+		else
+			{ 'country_code' => country_code }
+		end
+	 	fetch_ppp(geo)
   end
 
   private

data/lib/geo_ppp/version.rb

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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: geo_ppp
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.6
 platform: ruby
 authors:
 - waruna
 bindir: exe
 cert_chain: []
-date: 2025-01-09 00:00:00.000000000 Z
+date: 2025-01-24 00:00:00.000000000 Z
 dependencies: []
 description: A Ruby library to fetch PPP based on user's geolocation using freegeoip.com
   and purchasing-power-parity.com APIs.