rails_url_shortener 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0847fa49aa14c40889c11cdf80fd32a846208112f7b1e121455f6c6258225cf8'
-  data.tar.gz: 2479208e471351f49be2f9876f33ce22cc6cf6461c62113b0d5e5c66d8bd884a
+  metadata.gz: 964c9390d946bb5229d91c8760689cd5e001b7af1e3182b15e14087488c71a04
+  data.tar.gz: ee0971582ed1631913c0aa5ba8e43bbe4ecd5159931b9caa7723075363554102
 SHA512:
-  metadata.gz: 94658a6b36105a31e1abc8ce7ac9b67913e2fecec29a834f9898224b1969ac0f593ee72c157bbe149e75a439fe5d68efaa167aebc83758fdd85eb578aef3b047
-  data.tar.gz: f40c5f6dc58ab19cd03bd714db4d68431889733579dce5e61c8990964fdc82211cc8d95e20d36d54bdc6909b7f93e871ae3648bd21ab5977123c7c93f2a71fed
+  metadata.gz: 216e49e0c1f9caba3b04fb5cebdcbf524a7525bc5a249031f3d29556fdfd7cff471652500c6b80166085b305087bfb050005140c52dc02f3f4d499d9421d1ec4
+  data.tar.gz: 194d5777d67c70bd659c227dc03e9b347e21396cf00c732453a74b552b2e8cc2b289e80489528d70376b6f3e5a7b113f40fbd84e458d27e64f2feeeb3311680d

data/README.md

@@ -1,37 +1,74 @@
 # RailsUrlShortener
 
-A small rails engine for short urls.
-It could be used like a url shortener or a ip logger, it is your choice.
-The app generate a short url for you and then (if you want) receive the requests and redirect to the original url.
+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.
 
 Why give your data to a third party app if you can do it by yourself?
 
+## Key features
+
+A few 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.
+
 ## Usage
 
-Mount the controller on your app adding the next code on your config/routes.rb:
+### 1. Mount the engine
+
+Mount the engine on your app adding the next code on your config/routes.rb:
+
+**If you want to mount this on the root of your app, this should be on the bottom of your routes file.**
 
 ```ruby
 mount RailsUrlShortener::Engine, at: "/"
 
 ```
+### 2. Generate the short link
 
-And generate the short links wherever you want using the helper method:
+And generate the short links like you want:
+
+ - 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:
+ - 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
+
+**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.
+
 
-**Then share the short link.**
+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)
+```
 
-### Deeper
+### 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:
 
-By default this engine save all request made on your short url, you can use that data for some analitics 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 a Url:
 ```ruby
 RailsUrlShortener::Url.find_by_key("key").visits # all visits
 
@@ -41,11 +78,6 @@ Or using the model class:
 RailsUrlShortener::Visit.all # all in database
 ```
 
-Also the Url model has a polymorphic relation with an owner that is optional. So you can relate an url whatever you want in your app adding the next relation in a model:
-```ruby
-has_many :urls, as: :owner
-```
-
 ## Installation
 
 Add this line to your application's Gemfile:

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

@@ -4,8 +4,8 @@ CHARSETS = {
   alphanumcase: ('A'..'Z').to_a + ('a'..'z').to_a  + (0..9).to_a
 }
 
-RailsUrlShortener.default_redirect = "/"
-RailsUrlShortener.charset = CHARSETS[:alphanumcase]
-RailsUrlShortener.key_length = 6
-RailsUrlShortener.minimum_key_length = 3
-RailsUrlShortener.save_bots_visits = false
+RailsUrlShortener.default_redirect = "/"            # where the users are redirect if the link doesn't exists or is expired.
+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.save_bots_visits = false          # if save bots visits

data/lib/rails_url_shortener/version.rb

@@ -1,3 +1,3 @@
 module RailsUrlShortener
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_url_shortener
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - a-chacon
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-12 00:00:00.000000000 Z
+date: 2022-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -38,7 +38,23 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.3.0
-description: A little engine for rails application that provide url shortener functions.
+- !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
+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.
 email:
 - andres.ch@protonmail.com
 executables: []
@@ -67,9 +83,11 @@ homepage: https://www.github.com/a-chacon/rails_url_shortener
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://www.github.com/a-chacon/rails_url_shortener
-  source_code_uri: https://www.github.com/a-chacon/rails_url_shortener
-  changelog_uri: https://www.github.com/a-chacon/rails_url_shortener
+  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.1.1
+  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.1.1
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -78,12 +96,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.8.11
 requirements: []
 rubygems_version: 3.2.22
 signing_key: