active_connect 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d2bd3e27629d16544e40a2cbf963e3060b95c043f88754a84f1be54a11518cd
-  data.tar.gz: 11fe76063af6c27f221e80eec5a197d9cea4c255e5129179905f79e583553c6a
+  metadata.gz: c407dc134ca3ffbcb449c3bf7b44c07206efc8e05a92c30de2026bccdb06a954
+  data.tar.gz: eda55e4e6a2aa7747d8d4ad47fdadf5b419fa2c517fdec49191231b1e11bb2ec
 SHA512:
-  metadata.gz: 2bc3bd1853322a7a1c553f85487155e9323dd8c8e71e5c95a46de886bde589169f460373c0aaf1c3717eb60cbf53eda503c570f9a09d4f271951854480f11080
-  data.tar.gz: bcc9dd43b9b9182188f0c152ebc4359226e62ed361eac1f3f3a94ae16d19886118170608c90fd32f98d4508d2f624516ce5251ad6b74180a5b2133273f34c2f6
+  metadata.gz: 6bc09c444662721174ee1a1b989806ddf3ad6ceaadc7698cb232f7571e80105c88b759014dfbb82b72367730f50794baa50e6d535c56209cc97d6b867bd3870e
+  data.tar.gz: 54f1ed4766f2d61b77d6b461e429574866d3d48ca2d65d9b22cdc3223970e683e854c336b8bedc47250d74a459290c77b635bd47ad2f6d50723fa86f1e483dee

data/README.md

@@ -6,7 +6,20 @@ How to use my plugin.
 
 
 # Guide ME
+RAILS_ENV=test rails db:create
 RAILS_ENV=test rails generate active_connect:install
+RAILS_ENV=test rails test
+
+# Create Migration in dummy app
+cd test/dummy/
+RAILS_ENV=test rails generate migration CreateProducts name:string --app=dummy
+RAILS_ENV=test rails db:migrate
+
+# Drop
+RAILS_ENV=test rails db:drop
+
+
+# RAILS_ENV=test rails db:drop
 
 ## Installation
 Add this line to your application's Gemfile:

data/app/models/active_connect/active_connect_data.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+# app/models/active_connect/active_connect_data.rb
+
+require 'yaml'
+
+module ActiveConnect
+  class ActiveConnectData < ApplicationRecord
+    # Include the HTTParty module for making HTTP requests
+    include ActiveConnectDataIntegrations::Httparty
+    # Define the polymorphic association to the connectable model
+    belongs_to :connectable, polymorphic: true
+
+    # Validate the presence of the service attribute
+    validates :service, presence: true
+
+    # enum status
+    enum :status, [:success, :failed]
+
+    # Master method to fetch data from the service
+    def update_data
+      config = load_service_config  # Load the service-specific configuration
+      method_name = "#{config['engine']}_update_data"
+
+      if respond_to?(method_name, true)
+        data = send(method_name)
+        parse_data(data)
+      else
+        raise NoMethodError, "No method defined for engine '#{config['engine']}'"
+      end
+    end
+
+    def parse_data(data)
+      return unless connectable.respond_to?(:parse_data)
+
+      # Delegate parsing to the connectable model if it has `parse_data` defined
+      connectable.parse_data(data)
+    end
+
+    private
+
+    # Load service-specific configuration from the YAML file
+    def load_service_config
+      config = load_yaml_config
+      # Validate the service exists in the YAML config
+      raise "Service '#{service}' not found in configuration" unless config.key?(service)
+      config[service]
+    end
+
+    private
+
+    # Update the status to error and set the run_at timestamp
+    def update_data_failed
+      update(status: :error, run_at: Time.current)
+    end
+
+    # Update the status to success and set the run_at timestamp
+    def update_data_success
+      update(status: :success, run_at: Time.current)
+    end
+
+    # Define the number of request retries defaulting to 0
+    def request_retries
+      load_service_config.dig('request_retries') || 0
+    end
+
+    # Define the sleep time between requests defaulting to 0 seconds
+    def request_sleep
+      load_service_config.dig('sleep') || 0
+    end
+
+    # Define the request timeout defaulting to 60 seconds
+    def request_timeout
+      load_service_config.dig('timeout') || 60
+    end
+
+    # Define the request type defaulting to 'get'
+    def request_type
+      load_service_config.dig('request_type') || 'get'
+    end
+
+    # Define the URL to request data from defaulting to the 'url' column
+    def request_url
+      connectable[load_service_config.dig('url_column') || 'url']
+    end
+
+    # Load the YAML file and handle any errors in locating or parsing it
+    def load_yaml_config
+      config_path = Rails.root.join('config', 'connect.yml')
+      YAML.load_file(config_path, aliases: true)
+    rescue Errno::ENOENT
+      raise "Configuration file 'connect.yml' not found"
+    rescue Psych::SyntaxError => e
+      raise "YAML syntax error occurred while parsing connect.yml: #{e.message}"
+    end
+  end
+end

data/app/models/concerns/active_connect_data_integrations/httparty.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+# Path: app/models/concerns/active_connect_data_integrations/http_party.rb
+
+require "httparty"
+
+module ActiveConnectDataIntegrations
+  module Httparty
+    extend ActiveSupport::Concern
+
+    def httparty_update_data
+      @tries = 0
+      options = { headers: headers_settings, timeout: request_timeout }
+      options.merge!(proxy_settings) if proxy_settings
+      data = send_request(options)
+      data = { status: data.code, body: data.body }
+      save_data(data)
+      data
+    end
+
+    private
+
+    def save_data(data)
+      data[:status] == 200 ? update_data_success : update_data_failed
+      update(data: data)
+    end
+
+    def send_request(options)
+      sleep(request_sleep) if request_sleep.positive?
+      HTTParty.send(request_type, request_url, options)
+    rescue StandardError => e
+      retry if (@tries += 1) < request_retries
+      raise e
+    end
+
+    def proxy_settings
+      base_proxy_settings = {}
+      proxy_settings = load_service_config.dig('proxy')
+      return unless proxy_settings
+      proxy_split = proxy_settings.split(':')
+      return unless proxy_split.size > 1
+
+      base_proxy_settings[:http_proxyaddr] = proxy_split[0]
+      base_proxy_settings[:http_proxyport] = proxy_split[1]
+      return base_proxy_settings unless proxy_split.size == 4
+
+      base_proxy_settings[:http_proxyuser] = proxy_split[2]
+      base_proxy_settings[:http_proxypass] = proxy_split[3]
+      base_proxy_settings
+    end
+
+    def headers_settings
+      base_headers = {}
+      headers_settings = load_service_config.dig('request_headers')
+      return unless headers_settings
+
+      headers_settings.each do |header_key, header_value|
+        base_headers[header_key] = header_value
+      end
+      base_headers
+    end
+  end
+end

data/lib/active_connect/engine.rb

@@ -4,5 +4,11 @@
 module ActiveConnect
   class Engine < ::Rails::Engine
     isolate_namespace ActiveConnect
+
+    initializer "active_connect.model_additions" do
+      ActiveSupport.on_load(:active_record) do
+        include ActiveConnect
+      end
+    end
   end
 end

data/lib/active_connect/version.rb

@@ -1,6 +1,5 @@
-# frozen_string_literal: true
 # Path: lib/active_connect/version.rb
-
+#
 module ActiveConnect
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/active_connect.rb

@@ -5,5 +5,21 @@ require "active_connect/version"
 require "active_connect/engine"
 
 module ActiveConnect
-  # Your code goes here...
+  extend ActiveSupport::Concern
+
+  class_methods do
+    def has_one_connect(name, service:, dependent: :nullify)
+      # Define an association similar to ActiveStorage's `has_one_attached`
+      has_one :"#{name}_data", -> { where(service: service) }, class_name: "ActiveConnect::ActiveConnectData", as: :connectable, dependent: dependent
+      # Define a method to access the connection service
+      define_method(name) do
+        public_send("#{name}_data")
+      end
+
+      # Define a `connected?` method to check if a connection exists
+      define_method("#{name}_connected?") do
+        public_send("#{name}_data").present?
+      end
+    end
+  end
 end

data/lib/generators/{active_scrape → active_connect}/install_generator.rb

@@ -18,11 +18,15 @@ module ActiveConnect
     end
 
     def copy_scrape_yml
-      template "connect.yml", "config/connect.yml"
+      template "connect.yml", Rails.root.join("config/connect.yml")
     end
 
     def copy_migrations
-      migration_template "create_active_connect_data.rb", "db/migrate/create_active_connect_data.rb"
+      migration_template "create_active_connect_active_connect_data.rb", Rails.root.join("db/migrate/create_active_connect_active_connect_data.rb")
+    end
+
+    def add_require_to_application
+      inject_into_file Rails.root.join("config/application.rb"), "\nrequire 'active_connect'", after: "Bundler.require(*Rails.groups)"
     end
   end
 end

data/lib/generators/{active_scrape → active_connect}/templates/connect.yml

@@ -9,7 +9,7 @@ default: &default
 http_party:
   <<: *default
   engine: "httparty"
-  proxy: "http://your-proxy-server:port:username:password"
+  url_column: "not_url"
   request_headers:
     user_agent: "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/27.0.1453.110 Safari/537.36"
   request_type: "get"

data/lib/generators/{active_scrape/templates/create_active_connect_data.rb → active_connect/templates/create_active_connect_active_connect_data.rb}

@@ -1,13 +1,14 @@
 # frozen_string_literal: true
 # lib/generators/active_connect/templates/create_active_connect_data.rb
 #
-class CreateScrapeData < ActiveRecord::Migration[7.0]
+class CreateActiveConnectActiveConnectData < ActiveRecord::Migration[7.0]
   def change
-    create_table :active_connect_data do |t|
+    create_table :active_connect_active_connect_data do |t|
       t.references :connectable, polymorphic: true, index: true
       t.json :data
       t.datetime :run_at
       t.integer :status
+      t.string :service
       t.timestamps
     end
   end

data/lib/tasks/active_connect_tasks.rake

@@ -10,7 +10,7 @@ module ActiveConnect
   class_methods do
     def has_connect(connect_name)
       # Define scraping settings or initializations here
-      # You can store configurations in scrape.yml
+      # You can store configurations in connect.yml
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_connect
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - andersmarkc
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-09 00:00:00.000000000 Z
+date: 2024-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -48,15 +48,17 @@ files:
 - app/helpers/active_connect/application_helper.rb
 - app/jobs/active_connect/application_job.rb
 - app/mailers/active_connect/application_mailer.rb
+- app/models/active_connect/active_connect_data.rb
 - app/models/active_connect/application_record.rb
+- app/models/concerns/active_connect_data_integrations/httparty.rb
 - app/views/layouts/active_connect/application.html.erb
 - config/routes.rb
 - lib/active_connect.rb
 - lib/active_connect/engine.rb
 - lib/active_connect/version.rb
-- lib/generators/active_scrape/install_generator.rb
-- lib/generators/active_scrape/templates/connect.yml
-- lib/generators/active_scrape/templates/create_active_connect_data.rb
+- lib/generators/active_connect/install_generator.rb
+- lib/generators/active_connect/templates/connect.yml
+- lib/generators/active_connect/templates/create_active_connect_active_connect_data.rb
 - lib/tasks/active_connect_tasks.rake
 homepage: https://github.com/andersmarkc/active_connect
 licenses:
@@ -65,7 +67,7 @@ metadata:
   homepage_uri: https://github.com/andersmarkc/active_connect
   source_code_uri: https://github.com/andersmarkc/active_connect
   changelog_uri: https://github.com/andersmarkc/active_connect/blob/main/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -80,8 +82,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: A scraping utility for Rails applications, designed to work similarly to
   ActiveStorage.