rails_url_shortener 0.2.10 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d2eae8996ec1ecb9a6edf015f801174ba561d47a67f5898f516d8c37d4c10118
-  data.tar.gz: 4070d28713ebdf08bf96068f4a10c1ee2369c77568a8fb0a11ea8b206e1f0521
+  metadata.gz: 47080dc11acdaa0241ee52957569c21edbd5601520c0d38ec6af35235f908b93
+  data.tar.gz: 269295c42a9401047337940703d692514b93273d933556b8f6672ce06f636d49
 SHA512:
-  metadata.gz: b1d74a3df31a9b3a1eaa9eba0d2387ca1b2d572f40147ae12321172a093e998af28e63bdf8b8a6ab10416843a0c7e3a2574abe37ba5603b5086d0b8e5214eb8c
-  data.tar.gz: ccb01b9e625ee0f2a3a38992a978cade1e05b0fc8e0144e12e93e1a3c95ff59c7683d2cd20d66c3238e5a88d90432377b880c9bbf8ee6f31b69a8ebad0be791d
+  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://s.a-chacon.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/lib/rails_url_shortener/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsUrlShortener
-  VERSION = '0.2.10'
+  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
   ##

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: rails_url_shortener
 version: !ruby/object:Gem::Version
-  version: 0.2.10
+  version: 0.3.0
 platform: ruby
 authors:
 - a-chacon
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-31 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,10 +37,10 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.1.0
-description: RailsUrlShortener is a lightweight Rails engine that enables easy creation
-  and management of short URLs within your project. Similar to bitly.com, it condenses
-  long links into short, user-friendly addresses. Enhance your app's functionality
-  with this simple yet powerful URL shortening solution.
+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: []
@@ -83,17 +68,15 @@ files:
 - lib/rails_url_shortener/engine.rb
 - lib/rails_url_shortener/model.rb
 - lib/rails_url_shortener/version.rb
-- lib/tasks/auto_annotate_models.rake
 homepage: https://www.github.com/a-chacon/rails-url-shortener
 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.10
+  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.10
+  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
@@ -101,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.16
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Rails url shortener engine.
 test_files: []

data/lib/tasks/auto_annotate_models.rake

@@ -1,59 +0,0 @@
-# NOTE: only doing this in development as some production environments (Heroku)
-# NOTE: are sensitive to local FS writes, and besides -- it's just not proper
-# NOTE: to have a dev-mode tool do its thing in production.
-if Rails.env.development?
-  require 'annotate'
-  task :set_annotation_options do
-    # You can override any of these by setting an environment variable of the
-    # same name.
-    Annotate.set_defaults(
-      'active_admin'                => 'false',
-      'additional_file_patterns'    => [],
-      'routes'                      => 'false',
-      'models'                      => 'true',
-      'position_in_routes'          => 'before',
-      'position_in_class'           => 'before',
-      'position_in_test'            => 'before',
-      'position_in_fixture'         => 'before',
-      'position_in_factory'         => 'before',
-      'position_in_serializer'      => 'before',
-      'show_foreign_keys'           => 'true',
-      'show_complete_foreign_keys'  => 'false',
-      'show_indexes'                => 'true',
-      'simple_indexes'              => 'false',
-      'model_dir'                   => 'app/models',
-      'root_dir'                    => '',
-      'include_version'             => 'false',
-      'require'                     => '',
-      'exclude_tests'               => 'false',
-      'exclude_fixtures'            => 'false',
-      'exclude_factories'           => 'false',
-      'exclude_serializers'         => 'false',
-      'exclude_scaffolds'           => 'true',
-      'exclude_controllers'         => 'true',
-      'exclude_helpers'             => 'true',
-      'exclude_sti_subclasses'      => 'false',
-      'ignore_model_sub_dir'        => 'false',
-      'ignore_columns'              => nil,
-      'ignore_routes'               => nil,
-      'ignore_unknown_models'       => 'false',
-      'hide_limit_column_types'     => 'integer,bigint,boolean',
-      'hide_default_column_types'   => 'json,jsonb,hstore',
-      'skip_on_db_migrate'          => 'false',
-      'format_bare'                 => 'true',
-      'format_rdoc'                 => 'false',
-      'format_yard'                 => 'false',
-      'format_markdown'             => 'false',
-      'sort'                        => 'false',
-      'force'                       => 'false',
-      'frozen'                      => 'false',
-      'classified_sort'             => 'true',
-      'trace'                       => 'false',
-      'wrapper_open'                => nil,
-      'wrapper_close'               => nil,
-      'with_comment'                => 'true'
-    )
-  end
-
-  Annotate.load_tasks
-end