rails_url_shortener 0.2.9 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb56f22bb9dfb01fa0520b7793659d1561fc152403e6ec83b096a55c0d1caa2c
-  data.tar.gz: fa519f996fd694af8c1d3a9e8f35bd75d4211036cc2771fe534502d4aee7e991
+  metadata.gz: 47080dc11acdaa0241ee52957569c21edbd5601520c0d38ec6af35235f908b93
+  data.tar.gz: 269295c42a9401047337940703d692514b93273d933556b8f6672ce06f636d49
 SHA512:
-  metadata.gz: 8cc0b73eec14701368de967c3bf20e96cfc9c3fa53342c80d474329b723f27451d7235f7a2ed30d5656540af1eb746bd2148700804ac2d7ab10805568e80165e
-  data.tar.gz: 2a3cf586ac8ee40b56ae28cae470e66f0214b5037e129013ab99ab56a3bcf418bf973fbb14ddf1ff2eaaa79fe2086f53c61e264e9132485ec71c3a4151313785
+  metadata.gz: 64af1ffcb6346cf73b6cbfa5b16df9fc376bfa8c787db032f8207df12ad9bc772ab794d997eb3a2f091ad57dac510d1f0f42a6fae4115a0d553dccc4d73f53a0
+  data.tar.gz: b012dfa013e104668245ceca19e4d4834684cf8552a1699e14af8729f1c8b60fbc6ce94c301f0bab61b6570ab17bc2b5f5c763605b1c28dd8101e4a1906fe3e5

data/README.md

@@ -1,25 +1,53 @@
 # RailsUrlShortener
 
-RailsUrlShortener is a small rails engine that provide your app with short URLs functionalities. Like a Bitly on your app. By default, RailsUrlShortener save the visits to your link for future interesting things that you may want to do.
+RailsUrlShortener is a small Rails engine that provides your app with short URL functionality and IP logging capabilities - like having your own Bitly service. By default, RailsUrlShortener saves all visits to your links for future analysis or other interesting uses.
 
-Why give your data to a third party app if you can do it by yourself?
+Why give your data to a third-party app when you can manage it yourself?
 
-You can see a **demo project** of what you can do with this engine [HERE](https://paso-app.herokuapp.com/).
+You can see a **demo project** of what you can do with this engine [HERE](https://paso.fly.dev/).
 
-## Key features
+## Key Features
 
-A few of the things you can do with RailsUrlShortener:
+Here are some of the things you can do with RailsUrlShortener:
 
-* Generate unique keys for links.
-* Provide a method controller that find, save request information and does a 301 redirect to the original url.
-* The short links can be associated with a model in your app.
-* Save interesting things like browser, system and ip data of the 'un-shortened' request.
-* Temporal short links using the expires_at option.
-* Get IP data from third part service.
+* Generate unique keys for links
+* Provide a controller method that finds, saves request information, and performs a 301 redirect to the original URL
+* Associate short links with models in your app
+* Save browser, system, and IP data from each request
+* Create temporary short links using the expires_at option
+* Get IP data from a third-party service
+
+## Installation
+
+Follow these steps to install and configure RailsUrlShortener:
+
+1. Add this line to your application's Gemfile:
+
+```ruby
+gem "rails_url_shortener"
+```
+
+2. Install the gem by running:
+
+```bash
+bundle install
+```
+
+3. Install and run the migrations:
+
+```bash
+bin/rails rails_url_shortener:install:migrations db:migrate
+```
+
+4. Generate the initializer for configuration:
+
+```bash
+rails generate rails_url_shortener
+```
 
 ## Usage
 
-### 1. Mount the engine
+1. Mount the engine
 
 Mount the engine on your app adding the next code on your config/routes.rb:
 
@@ -29,96 +57,75 @@ Mount the engine on your app adding the next code on your config/routes.rb:
 mount RailsUrlShortener::Engine, at: "/"
 
 ```
-### 2. Generate the short link
+
+2. Generate the short link
 
 And generate the short links like you want:
 
- - Using the helper method, this return the ready short link.
+* Using the helper method, this return the ready short link.
 
 ```ruby
 short_url("https://www.github.com/a-chacon/rails-url-shortener")
 ```
 
- - Or model method, this return the object built. So you can save this on a variable, extract the key and build the short link by your own:
+* Or model method, this return the object built. So you can save this on a variable, extract the key and build the short link by your own:
 
 ```ruby
 RailsUrlShortener::Url.generate("https://www.github.com/a-chacon/rails-url-shortener")
 ```
-### 3. Share the short link
+
+3. Share the short link
 
 **Then share the short link to your users or wherever you want.**
 
 ## Deeper
 
 Full params for the short_url helper:
+
 ```ruby
 short_url(url, owner: nil, key: nil, expires_at: nil, category: nil, url_options: {})
 ```
+
 Where:
-* **url**: Long url for short.
-* **owner**: Is a model of your app. You can relate an url whatever you want in your app.
-* **key**: Is a custom key that you want to set up.
-* **expires_at**: Is a datetime for expiration, after this the redirection doesn't work.
-* **category**: Tag that you want for that link.
-* **url_options**: Options for the url_for generator. Ex: subdomain or protocol.
 
+* **url**: The long URL to be shortened
+* **owner**: A model from your app to associate with the URL
+* **key**: A custom key for the short URL (optional)
+* **expires_at**: Expiration datetime (after which the redirect won't work)
+* **category**: A tag for categorizing the link
+* **url_options**: Options for the URL generator (e.g., subdomain or protocol)
+
+The `generate` model method accepts the same parameters except for `url_options`:
 
-And the same for the generate model method except for url_options:
 ```ruby
 RailsUrlShortener::Url.generate(url, owner: nil, key: nil, expires_at: nil, category: nil)
 ```
 
-### Data saved
-
-By default, this engine save all request made on your short url, you can use that data for some analytics or simple IP logger. So for get the data in a controller or do wherever you want, you can use the Visit model related to an Url:
+### Data Collection
 
-```ruby
-RailsUrlShortener::Url.find_by_key("key").visits # all visits
+By default, the engine saves all requests made to your short URLs. You can use this data for analytics or IP logging. To access the data:
 
-```
-Or using the model class:
-```ruby
-RailsUrlShortener::Visit.all # all in database
-```
+1. Get visits for a specific URL:
 
-And a Visit is related to a Ipgeo model that contain information about the ip, so you can view this using the active record relation:
 ```ruby
-RailsUrlShortener::Visit.first.ipgeo # Ipgeo object that contain information of the ip
+RailsUrlShortener::Url.find_by_key("key").visits
 ```
 
-### Ip data
-
-When a Visit record is created, a job is enqueue for get Ip data from [this](https://ip-api.com/) service and create the Ipgeo record. It is integrated to the free endpoint, so if you think that you have more than 45 different IPS querying in a minute to your app, we need to think in a new solution.
-
-## Installation
-
-Add this line to your application's Gemfile:
+2. Get all visits:
 
 ```ruby
-gem "rails_url_shortener"
+RailsUrlShortener::Visit.all
 ```
 
-Or install it yourself as:
-```bash
-gem install rails_url_shortener
-```
-
-Then execute:
-```bash
-bundle
-```
+Each Visit is associated with an Ipgeo model that contains information about the IP address:
 
-And finally install & run the migrations on your project and migrate:
-```bash
-bin/rails rails_url_shortener:install:migrations db:migrate
+```ruby
+RailsUrlShortener::Visit.first.ipgeo
 ```
 
-For the configurations generate the initializer whith this:
+### IP Data Collection
 
-```bash
-rails generate RailsUrlShortener:initializer
-```
-**Here is important to configure the host at least if your are not running your app in localhost**
+When a Visit record is created, a background job is enqueued to fetch IP data from the [ip-api.com](https://ip-api.com/) service and create an Ipgeo record. This uses the free endpoint, which has a limit of 45 different IPs per minute. If you expect higher traffic, you'll need to implement an alternative solution.
 
 ## Contributing
 
@@ -134,4 +141,7 @@ Don't forget to give the project a star! Thanks again!
 5. Open a Pull Request
 
 ## License
+
 The gem is available as open source under the terms of the [GPL-3.0 License](https://www.github.com/a-chacon/rails-url-shortener/blob/main/LICENSE).
+
+by: [a-chacon](https://a-chacon.com)

data/Rakefile

@@ -17,10 +17,4 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList['test/**/*test.rb']
 end
 
-require 'rubocop/rake_task'
-
-RuboCop::RakeTask.new do |task|
-  task.requires << 'rubocop-minitest'
-end
-
-task default: %i[test rubocop]
+task default: %i[test]

data/app/models/rails_url_shortener/ipgeo.rb

@@ -1,5 +1,28 @@
 # frozen_string_literal: true
 
+# == Schema Information
+#
+# Table name: rails_url_shortener_ipgeos
+#
+#  id           :integer          not null, primary key
+#  as           :string
+#  city         :string
+#  country      :string
+#  country_code :string
+#  hosting      :boolean
+#  ip           :string
+#  isp          :string
+#  lat          :string
+#  lon          :string
+#  mobile       :boolean
+#  org          :string
+#  proxy        :boolean
+#  region       :string
+#  region_name  :string
+#  timezone     :string
+#  created_at   :datetime         not null
+#  updated_at   :datetime         not null
+#
 module RailsUrlShortener
   class Ipgeo < ApplicationRecord
     has_many :visits, dependent: :nullify

data/app/models/rails_url_shortener/url.rb

@@ -1,5 +1,23 @@
 # frozen_string_literal: true
 
+# == Schema Information
+#
+# Table name: rails_url_shortener_urls
+#
+#  id         :integer          not null, primary key
+#  category   :string
+#  expires_at :datetime
+#  key        :string(10)       not null
+#  owner_type :string
+#  url        :text             not null
+#  created_at :datetime         not null
+#  updated_at :datetime         not null
+#  owner_id   :integer
+#
+# Indexes
+#
+#  index_rails_url_shortener_urls_on_owner  (owner_type,owner_id)
+#
 module RailsUrlShortener
   class Url < ApplicationRecord
     # variables

data/app/models/rails_url_shortener/visit.rb

@@ -1,5 +1,28 @@
 # frozen_string_literal: true
 
+# == Schema Information
+#
+# Table name: rails_url_shortener_visits
+#
+#  id               :integer          not null, primary key
+#  bot              :boolean
+#  browser          :string
+#  browser_version  :string
+#  ip               :string
+#  meta             :text
+#  platform         :string
+#  platform_version :string
+#  user_agent       :string
+#  created_at       :datetime         not null
+#  updated_at       :datetime         not null
+#  ipgeo_id         :integer
+#  url_id           :integer
+#
+# Indexes
+#
+#  index_rails_url_shortener_visits_on_ipgeo_id  (ipgeo_id)
+#  index_rails_url_shortener_visits_on_url_id    (url_id)
+#
 module RailsUrlShortener
   require 'json'
   class Visit < ApplicationRecord

data/lib/generators/rails_url_shortener/templates/initializer.rb

@@ -10,5 +10,5 @@ RailsUrlShortener.host = ENV['HOST'] || 'localhost:3000' # the host used for the
 RailsUrlShortener.default_redirect = '/'            # where the users are redirect if the link is not found.
 RailsUrlShortener.charset = CHARSETS[:alphanumcase] # used for generate the keys, better long.
 RailsUrlShortener.key_length = 6                    # Key length for random generator
-RailsUrlShortener.minimum_key_length = 3            # minimun permited for a key
+RailsUrlShortener.minimum_key_length = 3            # minimum permited for a key
 RailsUrlShortener.save_bots_visits = false          # if save bots visits

data/lib/rails_url_shortener/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsUrlShortener
-  VERSION = '0.2.9'
+  VERSION = '0.3.0'
 end

data/lib/rails_url_shortener.rb

@@ -3,6 +3,7 @@
 require 'rails_url_shortener/version'
 require 'rails_url_shortener/engine'
 require 'rails_url_shortener/model'
+require_relative '../app/helpers/rails_url_shortener/urls_helper'
 
 module RailsUrlShortener
   ##
@@ -44,3 +45,11 @@ end
 ActiveSupport.on_load(:active_record) do
   extend RailsUrlShortener::Model
 end
+
+ActiveSupport.on_load(:action_view) do
+  prepend RailsUrlShortener::UrlsHelper
+end
+
+ActiveSupport.on_load(:action_controller_base) do
+  prepend RailsUrlShortener::UrlsHelper
+end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: rails_url_shortener
 version: !ruby/object:Gem::Version
-  version: 0.2.9
+  version: 0.3.0
 platform: ruby
 authors:
 - a-chacon
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-12 00:00:00.000000000 Z
+date: 2025-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: browser
@@ -24,20 +23,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.3.0
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.15.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.15.0
 - !ruby/object:Gem::Dependency
   name: http
   requirement: !ruby/object:Gem::Requirement
@@ -52,9 +37,10 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.1.0
-description: |-
-  RailsUrlShortener is a simple engine that provide to your rail's app the functionalities for
-     short URLs. Like bitly.com, but working on your project only.
+description: "RailsUrlShortener is a lightweight Rails engine that enables easy creation
+  and management of short URLs within your project. \nSimilar to bitly.com, it condenses
+  long links into short, user-friendly addresses. \nEnhance your app's functionality
+  with this simple yet powerful URL shortening solution.\n"
 email:
 - andres.ch@protonmail.com
 executables: []
@@ -87,11 +73,10 @@ licenses:
 - GPL-3.0
 metadata:
   bug_tracker_uri: https://www.github.com/a-chacon/rails-url-shortener/issues
-  changelog_uri: https://www.github.com/a-chacon/rails-url-shortener/releases/tag/v0.2.9
+  changelog_uri: https://www.github.com/a-chacon/rails-url-shortener/releases/tag/v0.3.0
   documentation_uri: https://github.com/a-chacon/rails-url-shortener/blob/main/README.md
-  source_code_uri: https://github.com/a-chacon/rails-url-shortener/tree/v0.2.9
+  source_code_uri: https://github.com/a-chacon/rails-url-shortener/tree/v0.3.0
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -99,15 +84,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: 1.8.11
 requirements: []
-rubygems_version: 3.4.14
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Rails url shortener engine.
 test_files: []