carddb-rails 0.1.0

data/lib/carddb/rails/resolver.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/object/blank'
+
+module CardDB
+  module Rails
+    module Resolver
+      module_function
+
+      def resolve_option(receiver, option)
+        case option
+        when Symbol
+          receiver.public_send(option)
+        when Proc
+          receiver.instance_exec(&option)
+        else
+          option
+        end
+      end
+
+      def resolve_required_option(receiver, option, name)
+        resolved = resolve_option(receiver, option)
+        raise ArgumentError, "#{name} is required" if resolved.blank?
+
+        resolved
+      end
+
+      def resolve_client(receiver, option)
+        resolved = resolve_option(receiver, option)
+        resolved || CardDB::Rails.client
+      end
+
+      def resolve_graphql_value(graphql_object, option)
+        case option
+        when Symbol
+          graphql_object.object.public_send(option)
+        when Proc
+          graphql_object.instance_exec(&option)
+        else
+          option
+        end
+      end
+
+      def resolve_graphql_client(graphql_object, option)
+        case option
+        when Proc
+          graphql_object.instance_exec(&option)
+        else
+          option
+        end
+      end
+    end
+  end
+end

data/lib/carddb/rails/test_helper.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module CardDB
+  module Rails
+    module TestHelper
+      def reset_carddb_rails_configuration!
+        CardDB.reset_configuration!
+        CardDB::Rails.reset_configuration!
+      end
+    end
+  end
+end

data/lib/carddb/rails/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module CardDB
+  module Rails
+    VERSION = '0.1.0'
+  end
+end

data/lib/carddb/rails.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require 'carddb'
+
+require_relative 'rails/version'
+require_relative 'rails/configuration'
+require_relative 'rails/controller_helpers'
+require_relative 'rails/deck_controller_helpers'
+require_relative 'rails/resolver'
+require_relative 'rails/deck_import_service'
+require_relative 'rails/deck_export_service'
+require_relative 'rails/deck_sync_service'
+require_relative 'rails/deck_sync_job'
+require_relative 'rails/has_carddb_record'
+require_relative 'rails/has_carddb_deck'
+require_relative 'rails/has_carddb_game'
+require_relative 'rails/has_carddb_dataset'
+require_relative 'rails/has_carddb_datasets'
+require_relative 'rails/has_carddb_publisher'
+require_relative 'rails/graphql/helpers'
+require_relative 'rails/graphql/dataloader/record_source'
+require_relative 'rails/graphql/dataloader/deck_source'
+require_relative 'rails/graphql/dataloader/deck_by_external_ref_source'
+require_relative 'rails/graphql/dataloader/game_source'
+require_relative 'rails/graphql/dataloader/dataset_source'
+require_relative 'rails/graphql/dataloader/publisher_source'
+require_relative 'rails/graphql/game_loader'
+require_relative 'rails/graphql/deck_loader'
+require_relative 'rails/graphql/dataset_loader'
+require_relative 'rails/graphql/publisher_loader'
+require_relative 'rails/graphql/record_loader'
+
+module CardDB
+  module Rails
+    class << self
+      def configuration
+        @configuration ||= Configuration.new
+      end
+
+      def configure
+        yield(configuration)
+        configuration
+      end
+
+      def reset_configuration!
+        @configuration = Configuration.new
+      end
+
+      def client
+        configuration.client || CardDB.default_client
+      end
+
+      def apply_rails_configuration!(app = ::Rails.application)
+        credentials = extract_credentials(app, configuration.credentials_key)
+        apply_credentials!(credentials) if credentials
+        apply_rails_defaults!
+      end
+
+      private
+
+      def apply_credentials!(credentials)
+        endpoint = credentials[:endpoint] || credentials['endpoint']
+
+        CardDB.configure do |config|
+          config.api_key ||= credentials[:api_key] || credentials['api_key']
+          config.publishable_key ||= credentials[:publishable_key] || credentials['publishable_key']
+          config.secret_key ||= credentials[:secret_key] || credentials['secret_key']
+          config.access_token ||= credentials[:access_token] || credentials['access_token']
+          config.endpoint = endpoint if endpoint
+        end
+      end
+
+      def apply_rails_defaults!
+        CardDB.configure do |config|
+          config.cache ||= ::Rails.cache if configuration.use_rails_cache
+          config.logger ||= ::Rails.logger if configuration.use_rails_logger
+        end
+      end
+
+      def extract_credentials(app, credentials_key)
+        credentials = if app.credentials.respond_to?(:dig)
+                        app.credentials[credentials_key]
+                      elsif app.credentials.respond_to?(credentials_key)
+                        app.credentials.public_send(credentials_key)
+                      end
+
+        credentials&.to_h || credentials
+      end
+    end
+  end
+end
+
+require_relative 'rails/railtie' if defined?(::Rails::Railtie)

data/lib/carddb-rails.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'carddb/rails'

data/lib/generators/carddb/install/install_generator.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+
+module CardDB
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      source_root ::File.expand_path('templates', __dir__)
+
+      def copy_initializer
+        template 'carddb.rb', 'config/initializers/carddb.rb'
+      end
+    end
+  end
+end

data/lib/generators/carddb/install/templates/carddb.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# Configure the CardDB client for this Rails app.
+CardDB.configure do |config|
+  credentials = Rails.application.credentials[:carddb] || {}
+
+  config.api_key = credentials[:api_key] if credentials[:api_key].present?
+  config.publishable_key = credentials[:publishable_key] if credentials[:publishable_key].present?
+  config.secret_key = credentials[:secret_key] if credentials[:secret_key].present?
+  config.access_token = credentials[:access_token] if credentials[:access_token].present?
+  config.endpoint = credentials[:endpoint] if credentials[:endpoint].present?
+
+  config.cache ||= Rails.cache
+  config.logger ||= Rails.logger
+
+  # Optional defaults:
+  # config.default_publisher = 'pokemon-company'
+  # config.default_game = 'pokemon-tcg'
+
+  # Optional restrictions:
+  # config.allowed_publishers = ['pokemon-company']
+  # config.allowed_games = { 'pokemon-company' => ['pokemon-tcg'] }
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: carddb-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- CardDB Team
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activejob
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: carddb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.5
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.5
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: graphql-batch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+description: Rails-specific helpers for CardDB, including model helpers, GraphQL batch
+  loaders, and Railtie configuration.
+email:
+- support@carddb.xtda.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/carddb-rails.rb
+- lib/carddb/rails.rb
+- lib/carddb/rails/configuration.rb
+- lib/carddb/rails/controller_helpers.rb
+- lib/carddb/rails/deck_controller_helpers.rb
+- lib/carddb/rails/deck_export_service.rb
+- lib/carddb/rails/deck_import_service.rb
+- lib/carddb/rails/deck_sync_job.rb
+- lib/carddb/rails/deck_sync_service.rb
+- lib/carddb/rails/graphql/dataloader/dataset_source.rb
+- lib/carddb/rails/graphql/dataloader/deck_by_external_ref_source.rb
+- lib/carddb/rails/graphql/dataloader/deck_source.rb
+- lib/carddb/rails/graphql/dataloader/game_source.rb
+- lib/carddb/rails/graphql/dataloader/publisher_source.rb
+- lib/carddb/rails/graphql/dataloader/record_source.rb
+- lib/carddb/rails/graphql/dataset_loader.rb
+- lib/carddb/rails/graphql/deck_loader.rb
+- lib/carddb/rails/graphql/game_loader.rb
+- lib/carddb/rails/graphql/helpers.rb
+- lib/carddb/rails/graphql/publisher_loader.rb
+- lib/carddb/rails/graphql/record_loader.rb
+- lib/carddb/rails/has_carddb_dataset.rb
+- lib/carddb/rails/has_carddb_datasets.rb
+- lib/carddb/rails/has_carddb_deck.rb
+- lib/carddb/rails/has_carddb_game.rb
+- lib/carddb/rails/has_carddb_publisher.rb
+- lib/carddb/rails/has_carddb_record.rb
+- lib/carddb/rails/railtie.rb
+- lib/carddb/rails/resolver.rb
+- lib/carddb/rails/test_helper.rb
+- lib/carddb/rails/version.rb
+- lib/generators/carddb/install/install_generator.rb
+- lib/generators/carddb/install/templates/carddb.rb
+homepage: https://github.com/carddb/carddb-rails
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/carddb/carddb-rails
+  changelog_uri: https://github.com/carddb/carddb-rails/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.9
+specification_version: 4
+summary: Rails integration for the CardDB Ruby client
+test_files: []