rails_url_shortener 0.1.0 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0847fa49aa14c40889c11cdf80fd32a846208112f7b1e121455f6c6258225cf8'
-  data.tar.gz: 2479208e471351f49be2f9876f33ce22cc6cf6461c62113b0d5e5c66d8bd884a
+  metadata.gz: ffbe916c8f609fdc0f2d3eeeaa418fef1ac4ee79ef06168d49fe5e203d0cb13a
+  data.tar.gz: c9c73896eb476662e60e2999bc88a1a664c70b2d963100fbd4dc782ccd52249e
 SHA512:
-  metadata.gz: 94658a6b36105a31e1abc8ce7ac9b67913e2fecec29a834f9898224b1969ac0f593ee72c157bbe149e75a439fe5d68efaa167aebc83758fdd85eb578aef3b047
-  data.tar.gz: f40c5f6dc58ab19cd03bd714db4d68431889733579dce5e61c8990964fdc82211cc8d95e20d36d54bdc6909b7f93e871ae3648bd21ab5977123c7c93f2a71fed
+  metadata.gz: f084c9720acb322664f424ba1d6d8e3f30b102caa5091eae1a66a2eae62242460dda2b86b0eeef46ade2321101cfd0f4fd6b9fea1818ba10653e96ce876374e1
+  data.tar.gz: 0141c770be77c10aa15354685e21ef51539547d690cdb2cd3e66f2deda6472245506e9704c7b1b6149dda8f5d417433293bcc8c7b6e1dd9ed9e22cbbe692e66d

data/README.md

@@ -1,37 +1,76 @@
 # 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?
 
+You can see a **demo project** of what you can do with this engine [HERE]("https://paso-app.herokuapp.com/").
+
+## 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 like you want:
 
-And generate the short links wherever you want using the helper method:
+ - Using the helper method, this return the ready short link.
 
 ```ruby
-short_url("https://www.github.com/a-chacon/rails_url_shortener")
+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")
+RailsUrlShortener::Url.generate("https://www.github.com/a-chacon/rails-url-shortener")
 ```
+### 3. Share the short link
 
-**Then share the short link.**
+**Then share the short link to your users or wherever you want.**
 
-### Deeper
+## 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.
+
+
+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:
 
-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 +80,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:
@@ -69,11 +103,12 @@ And finally install the migrations on your project and migrate:
 bin/rails rails_url_shortener:install:migrations db:migrate
 ```
 
-If you want the initializer for configurations do:
+For the configurations generate the initializer whith this:
 
 ```bash
 rails generate RailsUrlShortener:initializer
 ```
+**Here is important to configure the host at least if your are not running your app in localhost**
 
 ## Contributing
 
@@ -89,4 +124,4 @@ 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 [MIT License](https://opensource.org/licenses/MIT).
+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).

data/app/helpers/rails_url_shortener/urls_helper.rb

@@ -1,6 +1,13 @@
 module RailsUrlShortener
   module UrlsHelper
+    ##
+    # helper for generate short urls
+    #
+    # this method return a short url or the original url if something is bad
+    # Usage:
+    # short_url("https://tools.ietf.org/search/rfc2616#section-5.3")
     def short_url(url, owner: nil, key: nil, expires_at: nil, category: nil, url_options: {})
+      # generate
       url_object = Url.generate(
         url,
         owner: owner,
@@ -10,17 +17,18 @@ module RailsUrlShortener
       )
 
       if url_object.errors.empty?
-        # This must be fixed
-        # the url_for helper must generate the url
-        # options = {
-        #   controller: "rails_url_shortener_url/urls",
-        #   action: "show",
-        #   key: url.key
-        # }.merge(url_options)
+        # options for url_for
+        options = {
+          controller: "rails_url_shortener/urls",
+          action: "show",
+          key: url_object.key,
+          host: RailsUrlShortener.host
+        }.merge(url_options)
 
-        # url_for(options)
-        rails_url_shortener_url + url_object.key
+        # use helper of this engine
+        RailsUrlShortener::Engine.routes.url_for(options)
       else
+        # if not saved, return original url
         url
       end
     end

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

@@ -4,8 +4,9 @@ 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.host = "localhost:3000"           # the host used for the helper
+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.3"
 end

data/lib/rails_url_shortener.rb

@@ -11,6 +11,10 @@ module RailsUrlShortener
     alphanumcase: ('A'..'Z').to_a + ('a'..'z').to_a  + (0..9).to_a
   }
 
+  ##
+  # host for build final url on helper
+  mattr_accessor :host, default: 'test.host'
+
   ##
   # default redirection url when the key isn't found
   mattr_accessor :default_redirect, default: '/'

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.3
 platform: ruby
 authors:
 - a-chacon
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-12 00:00:00.000000000 Z
+date: 2022-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -38,18 +38,32 @@ 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: []
 extensions: []
 extra_rdoc_files: []
 files:
-- MIT-LICENSE
 - README.md
 - Rakefile
 - app/controllers/rails_url_shortener/urls_controller.rb
-- app/helpers/rails_url_shortener/application_helper.rb
 - app/helpers/rails_url_shortener/urls_helper.rb
 - app/models/rails_url_shortener/application_record.rb
 - app/models/rails_url_shortener/url.rb
@@ -63,13 +77,15 @@ files:
 - lib/rails_url_shortener/engine.rb
 - lib/rails_url_shortener/version.rb
 - lib/tasks/rails_url_shortener_tasks.rake
-homepage: https://www.github.com/a-chacon/rails_url_shortener
+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.3
+  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.3
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -78,12 +94,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:

data/MIT-LICENSE

@@ -1,20 +0,0 @@
-Copyright 2022 a-chacon
-
-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/app/helpers/rails_url_shortener/application_helper.rb

@@ -1,4 +0,0 @@
-module RailsUrlShortener
-  module ApplicationHelper
-  end
-end