rails_url_shortener 0.2.2 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d4a481aa504c85571a337b3fef38e9f7c5f6b498b18eb0dbb96cc19a28648a0
-  data.tar.gz: 0d57d071fccde22b9855f47663a6737eecb1a9329b3c4dbdc553744bdbcaf5c7
+  metadata.gz: 6aeebf6acccb2b42410986eb0328a509bebf98a1615a60836804f8c62e525ecf
+  data.tar.gz: 7a08775acadc07b9d0a12286056a02f496db98eebe6e87bc913c91d230f60d82
 SHA512:
-  metadata.gz: ce7e9633744aea66572207d0fd12ef5f75dd3a48044fa3dd0d9f3e3ed5b13fcc38fed290dad5f0a00da630fff903f4754dc77201de8e5d8f1243092a85a80260
-  data.tar.gz: c400166ae93286517a6b5f876e431d034ae8e7ac6b293967671a0b75a99c3a0d7faa45fa9981ea35c871da9a0b40652249b1f9c7cdca591726cebba60d00844e
+  metadata.gz: b38105a3f020cbf8304bf8a19f9db19c4ff6e1aa4b7f6364060a54d10d0d5d97094d17d39e2b96b0002325fe03816b899eb8a021f3bfa015186e93c871f1a08e
+  data.tar.gz: 500fc4916e53ce218043ba388c9302f9010f614adf4ac90bb790b835792bb381192181eeb8beff8c8dd93825d736785cac84edf208843d1c2e67c6c712769020

data/README.md

@@ -15,6 +15,7 @@ A few of the things you can do with RailsUrlShortener:
 * 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.
 
 ## Usage
 
@@ -80,6 +81,15 @@ Or using the model class:
 RailsUrlShortener::Visit.all # all in database
 ```
 
+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
+```
+
+### 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:

data/Rakefile

@@ -1,8 +1,26 @@
-require "bundler/setup"
+# frozen_string_literal: true
 
-APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
-load "rails/tasks/engine.rake"
+require 'bundler/setup'
 
-load "rails/tasks/statistics.rake"
+APP_RAKEFILE = File.expand_path('test/dummy/Rakefile', __dir__)
+load 'rails/tasks/engine.rake'
 
-require "bundler/gem_tasks"
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.warning = false
+  t.libs << 'test'
+  t.libs << 'lib'
+  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]

data/app/controllers/rails_url_shortener/urls_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsUrlShortener
   class UrlsController < ActionController::Metal
     include ActionController::StrongParameters

data/app/helpers/rails_url_shortener/urls_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsUrlShortener
   module UrlsHelper
     ##
@@ -19,8 +21,8 @@ module RailsUrlShortener
       if url_object.errors.empty?
         # options for url_for
         options = {
-          controller: "rails_url_shortener/urls",
-          action: "show",
+          controller: 'rails_url_shortener/urls',
+          action: 'show',
           key: url_object.key,
           host: RailsUrlShortener.host
         }.merge(url_options)

data/app/jobs/rails_url_shortener/application_job.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsUrlShortener
   class ApplicationJob < ActiveJob::Base
     # Automatically retry jobs that encountered a deadlock

data/app/jobs/rails_url_shortener/ip_crawler_job.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsUrlShortener
   class IpCrawlerJob < ApplicationJob
     queue_as :default
@@ -11,12 +13,16 @@ module RailsUrlShortener
     # create or update an existing record information for an ip
 
     def perform(visit)
-      if Ipgeo.exists?(ip: visit.ip) && Ipgeo.find_by(ip: visit.ip).updated_at <= Time.now - 3.months
-        # Then update
-        ip = HTTP.get("http://ip-api.com/json/#{visit.ip}?fields=status,message,country,countryCode,region,regionName,city,zip,lat,lon,timezone,isp,org,as,mobile,proxy,hosting,query")
-        if ip.code == 200
-          ipgeo = Ipgeo.find_by(ip: visit.ip)
-          ipgeo.update(JSON.parse(ip.body).transform_keys { |key| key.to_s.underscore }.slice(*Ipgeo.column_names))
+      if Ipgeo.exists?(ip: visit.ip)
+        ipgeo = Ipgeo.find_by(ip: visit.ip)
+        if Ipgeo.find_by(ip: visit.ip).updated_at <= 3.months.ago
+          # Then update
+          ip = HTTP.get("http://ip-api.com/json/#{visit.ip}?fields=status,message,country,countryCode,region,regionName,city,zip,lat,lon,timezone,isp,org,as,mobile,proxy,hosting,query")
+          if ip.code == 200
+            ipgeo.update(JSON.parse(ip.body).transform_keys { |key| key.to_s.underscore }.slice(*Ipgeo.column_names))
+            visit.update(ipgeo: ipgeo)
+          end
+        else
           visit.update(ipgeo: ipgeo)
         end
       elsif !Ipgeo.exists?(ip: visit.ip)
@@ -29,8 +35,8 @@ module RailsUrlShortener
           visit.update(ipgeo: ipgeo)
         end
       end
-    rescue Exception => e
-      print('Error' + e.to_s)
+    rescue StandarError => e
+      Rails.logger.debug { "Error#{e}" }
     end
   end
 end

data/app/models/rails_url_shortener/application_record.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsUrlShortener
   class ApplicationRecord < ActiveRecord::Base
     self.abstract_class = true

data/app/models/rails_url_shortener/ipgeo.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module RailsUrlShortener
   class Ipgeo < ApplicationRecord
-    has_many :visits
+    has_many :visits, dependent: :nullify
   end
 end

data/app/models/rails_url_shortener/url.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsUrlShortener
   class Url < ApplicationRecord
     # variables
@@ -5,7 +7,7 @@ module RailsUrlShortener
 
     # relations
     belongs_to :owner, polymorphic: true, optional: true
-    has_many :visits
+    has_many :visits, dependent: :nullify
 
     # validations
     validates :key, presence: true, length: { minimum: RailsUrlShortener.minimum_key_length }, uniqueness: true
@@ -14,9 +16,9 @@ module RailsUrlShortener
     # exclude records in which expiration time is set and expiration time is greater than current time
     scope :unexpired, -> { where(arel_table[:expires_at].eq(nil).or(arel_table[:expires_at].gt(::Time.current))) }
 
+    after_initialize :set_attr
     # callbacks
     before_validation :generate_key
-    after_initialize :set_attr
 
     ##
     # set default instance variables values
@@ -74,14 +76,14 @@ module RailsUrlShortener
     end
 
     def generate_key
-      if key.nil?
-        loop do
-          # plus to the key length if after 10 attempts was not found a candidate
-          self.key_length += 1 if generating_retries >= 10
-          self.key = key_candidate
-          self.generating_retries += 1
-          break unless self.class.exists?(key: key)
-        end
+      return unless key.nil?
+
+      loop do
+        # plus to the key length if after 10 attempts was not found a candidate
+        self.key_length += 1 if generating_retries >= 10
+        self.key = key_candidate
+        self.generating_retries += 1
+        break unless self.class.exists?(key: key)
       end
     end
   end

data/app/models/rails_url_shortener/visit.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsUrlShortener
   require 'json'
   class Visit < ApplicationRecord
@@ -11,19 +13,19 @@ module RailsUrlShortener
 
     def self.parse_and_save(url, request)
       # browser detection
-      browser = Browser.new(request.headers['User-Agent'])
-      if !RailsUrlShortener.save_bots_visits && browser.bot?
+      browser(request)
+      if !RailsUrlShortener.save_bots_visits && @browser.bot?
         false
       else
         # save
         visit = Visit.create(
           url: url,
           ip: request.ip,
-          browser: browser.name,
-          browser_version: browser.full_version,
-          platform: browser.platform.name,
-          platform_version: browser.platform.version,
-          bot: browser.bot?,
+          browser: @browser.name,
+          browser_version: @browser.full_version,
+          platform: @browser.platform.name,
+          platform_version: @browser.platform.version,
+          bot: @browser.bot?,
           user_agent: request.headers['User-Agent']
         )
         # We enqueue a job for get more data later
@@ -31,5 +33,9 @@ module RailsUrlShortener
         visit
       end
     end
+
+    def self.browser(request)
+      @browser = Browser.new(request.headers['User-Agent'])
+    end
   end
 end

data/db/migrate/20220418184647_create_rails_url_shortener_ipgeos.rb

@@ -21,6 +21,7 @@ class CreateRailsUrlShortenerIpgeos < ActiveRecord::Migration[7.0]
     add_column :rails_url_shortener_visits, :ipgeo_id, :integer
     add_index :rails_url_shortener_visits, :ipgeo_id
   end
+
   def down
     remove_column :rails_url_shortener_visits, :ipgeo_id
     drop_table :rails_url_shortener_ipgeos

data/lib/generators/rails_url_shortener/rails_url_shortener_generator.rb

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 require 'rails/generators'
 
 class RailsUrlShortenerGenerator < Rails::Generators::Base
-
-  source_root File.expand_path("templates", __dir__)
+  source_root File.expand_path('templates', __dir__)
 
   def copy
-    copy_file "initializer.rb", "config/initializers/rails_url_shortener.rb"
+    copy_file 'initializer.rb', 'config/initializers/rails_url_shortener.rb'
   end
-
 end

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

@@ -1,11 +1,13 @@
+# frozen_string_literal: true
+
 CHARSETS = {
   alphanum: ('a'..'z').to_a + (0..9).to_a,
   alphacase: ('a'..'z').to_a + ('A'..'Z').to_a,
-  alphanumcase: ('A'..'Z').to_a + ('a'..'z').to_a  + (0..9).to_a
-}
+  alphanumcase: ('A'..'Z').to_a + ('a'..'z').to_a + (0..9).to_a
+}.freeze
 
-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.host = 'localhost:3000'           # the host used for the helper
+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

data/lib/rails_url_shortener/engine.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsUrlShortener
   class Engine < ::Rails::Engine
     isolate_namespace RailsUrlShortener

data/lib/rails_url_shortener/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsUrlShortener
-  VERSION = "0.2.2"
+  VERSION = '0.2.5'
 end

data/lib/rails_url_shortener.rb

@@ -1,15 +1,16 @@
-require "rails_url_shortener/version"
-require "rails_url_shortener/engine"
+# frozen_string_literal: true
 
-module RailsUrlShortener
+require 'rails_url_shortener/version'
+require 'rails_url_shortener/engine'
 
+module RailsUrlShortener
   ##
   # constants
   CHARSETS = {
     alphanum: ('a'..'z').to_a + (0..9).to_a,
     alphacase: ('a'..'z').to_a + ('A'..'Z').to_a,
-    alphanumcase: ('A'..'Z').to_a + ('a'..'z').to_a  + (0..9).to_a
-  }
+    alphanumcase: ('A'..'Z').to_a + ('a'..'z').to_a + (0..9).to_a
+  }.freeze
 
   ##
   # host for build final url on helper
@@ -37,5 +38,4 @@ module RailsUrlShortener
   # so if you put this configuration like false could lose some visits to your link
   # by default saving all requests
   mattr_accessor :save_bots_visits, default: true
-
 end

data/lib/tasks/rails_url_shortener_tasks.rake

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # desc "Explaining what the task does"
 # task :rails_url_shortener do
 #   # Task goes here

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: rails_url_shortener
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.5
 platform: ruby
 authors:
 - a-chacon
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-19 00:00:00.000000000 Z
+date: 2022-05-20 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 7.0.2.3
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 7.0.2.3
 - !ruby/object:Gem::Dependency
   name: browser
   requirement: !ruby/object:Gem::Requirement
@@ -66,9 +52,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.0.4
-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 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: []
@@ -101,9 +87,9 @@ 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.2
+  changelog_uri: https://www.github.com/a-chacon/rails-url-shortener/releases/tag/v0.2.5
   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.2
+  source_code_uri: https://github.com/a-chacon/rails-url-shortener/tree/v0.2.5
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []