api_record 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b539925125802f0bbf668f5f5feb22cb89d7c1e1907a9e61b66550bd5e05534c
+  data.tar.gz: d277bb682de2964c9101776cf8d871d419e3477ab361412e1e5da62a6489f36f
+SHA512:
+  metadata.gz: e687a8e8738f278a8fed2734181b2d568432c2c25f9511d58def209378265cae525c3745131e03c91b7f8af189f18a6dd902f4c494397e8777eb58159603922a
+  data.tar.gz: 2d6399dfd008939dedd3d2cd57599abca8855db5224c5b6d59d3b62025803b1d6a1c6560e69de765775db3e32f4881a4d27a60235f46e00aaaefb34f80113762

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in api_record.gemspec
+gemspec
+
+
+group :development, :test do
+  gem "webmock", "~> 3.8"
+end

data/Gemfile.lock

@@ -0,0 +1,79 @@
+PATH
+  remote: .
+  specs:
+    api_record (0.0.1)
+      activemodel (>= 6, < 7.2)
+      faraday (>= 2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (7.1.2)
+      activesupport (= 7.1.2)
+    activesupport (7.1.2)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      mutex_m
+      tzinfo (~> 2.0)
+    addressable (2.8.6)
+      public_suffix (>= 2.0.2, < 6.0)
+    base64 (0.2.0)
+    bigdecimal (3.1.5)
+    concurrent-ruby (1.2.2)
+    connection_pool (2.4.1)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.5.0)
+    drb (2.2.0)
+      ruby2_keywords
+    faraday (2.8.1)
+      base64
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (3.0.2)
+    hashdiff (1.1.0)
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
+    minitest (5.20.0)
+    mutex_m (0.2.0)
+    public_suffix (5.0.4)
+    rake (13.1.0)
+    rexml (3.2.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    ruby2_keywords (0.0.5)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    webmock (3.19.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  api_record!
+  bundler
+  rake
+  rspec
+  webmock (~> 3.8)
+
+BUNDLED WITH
+   2.2.32

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Takuya Nishio
+
+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/README.md

@@ -0,0 +1,39 @@
+# ApiRecord
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/api_record`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'api_record'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install api_record
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/api_record.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: %i[spec]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "api_record"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/api_record/all.rb

@@ -0,0 +1,19 @@
+require 'active_support/all'
+require "api_record/base"
+require "api_record/destroyable"
+require "api_record/errors"
+require "api_record/findable"
+require "api_record/indexable"
+require "api_record/saveable"
+
+module ApiRecord
+  module All
+    extend ActiveSupport::Concern
+
+    include ApiRecord::Base
+    include ApiRecord::Findable
+    include ApiRecord::Indexable
+    include ApiRecord::Saveable
+    include ApiRecord::Destroyable
+  end
+end

data/lib/api_record/base.rb

@@ -0,0 +1,155 @@
+require "active_model"
+require 'active_support/all'
+require "faraday"
+require_relative 'errors'
+
+module ApiRecord
+  module Base
+    extend ActiveSupport::Concern
+    include ActiveModel::Model
+    include ActiveModel::Attributes
+    include ActiveModel::Serializers::JSON
+
+    included do
+      private 
+
+      attr_accessor :response
+    end
+
+    class_methods do
+      def api_url
+        'http://localhost:3000'
+      end
+
+      def client
+        ::Faraday.new(url: api_url) do |faraday|
+          configure_faraday(faraday)
+        end
+      end
+
+      def configure_faraday(faraday)
+        default_config.call(faraday)
+        @config_f.call(faraday) if @config_f
+      end
+
+      def default_config
+        lambda do |faraday|
+          faraday.adapter ::Faraday.default_adapter
+          faraday.request :json
+          # faraday.response :logger unless Rails.env.test?
+          faraday.response :json
+        end
+      end
+
+      def faraday_configure(&block)
+        @config_f = block
+      end
+
+      def raise_api_exception(response)
+        case response.status
+        when 404
+          raise ApiNotFound.new(response), "Record not found"
+        when 422
+          raise ApiInvalidError.new(response), "Invalid data"
+        when 400..499
+          raise HttpClientError.new(response), "Client error"
+        when 500..599
+          raise HttpServerError.new(response), "Server error"
+        else
+          raise ApiError.new(response), "Api Error"
+        end
+      end
+
+      def request(method, *args, &block)
+        response = client.public_send(method, *args) do |req|
+          yield req if block_given?
+        end
+        if response.success?
+          response
+        else
+          raise_api_exception(response)
+        end
+      end
+    end
+
+    def inspect
+      attributes_to_display = self.class.attribute_names.map(&:to_s) + ['response']
+      attributes_string = attributes_to_display.map { |attr| "#{attr}: #{send(attr).inspect}" }.join(', ')
+      "#<#{self.class.name} #{attributes_string}>"
+    end
+
+    def has_error?
+      errors.any?
+    end
+
+    def validate!
+      raise RecordInvalidError.new(self) unless valid?
+    end
+
+    private
+
+    def request(method, *args, &block)
+      @response = self.class.client.public_send(method, *args) do |req|
+        yield req if block_given?
+      end
+      if response.success?
+        true
+      else
+        handle_api_errors
+      end
+    end
+
+    def request!(method, *args, &block)
+      @response = self.class.client.public_send(method, *args) do |req|
+        yield req if block_given?
+      end
+      if response.success?
+        self
+      else
+        raise_api_exception
+      end
+    end
+
+    def raise_api_exception
+      case response.status
+      when 404
+        raise ApiNotFound.new(response), "Record not found"
+      when 422
+        add_api_errors
+        raise RecordInvalidError.new(self, response)
+      when 400..499
+        raise HttpClientError.new(response), "Client error"
+      when 500..599
+        raise HttpServerError.new(response), "Server error"
+      else
+        raise ApiError.new(response), "Api Error"
+      end
+    end
+
+    def handle_api_errors
+      raise_api_exception
+    rescue RecordInvalidError
+      false
+    end
+
+    def add_api_errors
+      error_message = :unknown_error
+
+      # Get the custom error message if available, otherwise use the default message
+      custom_error_key = "activemodel.errors.models.#{self.class.name.underscore}.response.#{error_message}"
+      common_error_key = "activemodel.errors.api_record.response.#{error_message}"
+      error_message_text = I18n.t(custom_error_key, default: I18n.t(common_error_key))
+
+      errors.add(:response, error_message_text)
+
+      error_response = response.body
+      if error_response.is_a?(Hash)
+        error_response.each do |key, error_details|
+          error_details.each do |message|
+            errors.add(key, message)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/api_record/destroyable.rb

@@ -0,0 +1,28 @@
+require "api_record/base"
+require "api_record/findable"
+module ApiRecord
+  module Destroyable
+    extend ActiveSupport::Concern
+    include ApiRecord::Base
+    include ApiRecord::Findable
+
+    def destroy
+      request(:delete, "#{self.class.api_path}/#{id}")
+      if response.success?
+        true
+      else
+        handle_api_errors()
+        false
+      end
+    end
+
+    def destroy!
+      request(:delete, "#{self.class.api_path}/#{id}")
+      if response.success?
+        self
+      else
+        raise_api_exception()
+      end
+    end
+  end
+end

data/lib/api_record/errors.rb

@@ -0,0 +1,34 @@
+module ApiRecord
+  class TimeoutError < StandardError; end
+
+  class RecordInvalidError < StandardError
+    attr_reader :record, :response
+
+    def initialize(record, response = nil)
+      @record = record
+      @response = response
+      message = "Validation failed: #{record.errors.full_messages.join(', ')}"
+      super(message)
+    end
+  end
+
+  class ApiInvalidError < StandardError
+    attr_reader :response
+
+    def initialize(response)
+      @response = response
+    end
+  end
+
+  class ApiError < StandardError
+    attr_reader :response
+
+    def initialize(response)
+      @response = response
+    end
+  end
+
+  class HttpClientError < ApiError; end
+  class HttpServerError < ApiError; end
+  class ApiNotFound < HttpClientError; end
+end

data/lib/api_record/findable.rb

@@ -0,0 +1,33 @@
+require_relative 'errors'
+
+module ApiRecord
+  module Findable
+    extend ActiveSupport::Concern
+
+    include Base
+
+    included do
+      attribute :id, :integer
+    end
+
+    class_methods do
+      def api_path
+        "#{name.pluralize.underscore}"
+      end
+
+      def find(id)
+        response = request(:get, "#{api_path}/#{id}")
+        if response.success?
+          body = response.body.deep_transform_keys!(&:underscore)
+          new(body)
+        else
+          raise_api_exception(response)
+        end
+      end
+    end
+
+    def new_record?
+      id.nil?
+    end
+  end
+end

data/lib/api_record/index_collection.rb

@@ -0,0 +1,3 @@
+module ApiRecord
+  IndexCollection = Struct.new(:items, :response)
+end

data/lib/api_record/indexable.rb

@@ -0,0 +1,30 @@
+require 'api_record/base'
+require 'api_record/index_collection'
+
+module ApiRecord
+  module Indexable
+    extend ActiveSupport::Concern
+    include ApiRecord::Base
+
+    class_methods do
+      def api_path
+        "#{name.pluralize.underscore}"
+      end
+
+      def index(page: 1, limit: 30)
+        params = {
+          page: page,
+          limit: limit
+        }
+        response = request(:get, "#{api_path}", params)
+        if response.success?
+          ApiRecord::IndexCollection.new(response.body.map do |attributes| 
+            new(attributes.deep_transform_keys!(&:underscore)) 
+          end, response)
+        else
+          raise_api_exception(response)
+        end
+      end
+    end
+  end
+end

data/lib/api_record/relation.rb

@@ -0,0 +1,3 @@
+module ApiRecord
+  Relation = Struct.new(:data, :response)
+end

data/lib/api_record/saveable.rb

@@ -0,0 +1,80 @@
+module ApiRecord
+  module Saveable
+    extend ActiveSupport::Concern
+    include Base
+    include Findable
+
+    class_methods do
+      def request_params(param)
+        param
+      end
+
+      def create(params)
+        record = new(params)
+        record.save
+        record
+      end
+
+      def create!(params)
+        record = new(params)
+        record.save!
+        record
+      end
+    end
+
+    def update!(params)
+      self.attributes = params
+      save!
+    end
+
+    def update(params)
+      self.attributes = params
+      save
+    end
+
+    def save
+      return false unless valid?
+
+      result = perform_save_request
+      if result
+        if response.body.present?
+          body = response.body.deep_transform_keys!(&:underscore)
+          self.attributes = body
+        end
+      end
+      result
+    end
+
+    def save!
+      validate!
+
+      perform_save_request!
+
+      if response.body.present?
+        body = response.body.deep_transform_keys!(&:underscore)
+        self.attributes = body
+      end
+      self
+    end
+
+    def perform_save_request!
+      params = self.class.request_params(attributes)
+      params.delete("id")
+      if new_record?
+        request!(:post, "#{self.class.api_path}", params)
+      else
+        request!(:put, "#{self.class.api_path}/#{id}", params)
+      end
+    end
+
+    def perform_save_request
+      params = self.class.request_params(attributes)
+      params.delete("id")
+      if new_record?
+        request(:post, "#{self.class.api_path}", params)
+      else
+        request(:put, "#{self.class.api_path}/#{id}", params)
+      end
+    end
+  end
+end

data/lib/api_record/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ApiRecord
+  VERSION = "0.0.1"
+end

data/lib/api_record.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+require_relative "api_record/version"
+require_relative "api_record/all"
+
+# module ApiRecord
+#   class Error < StandardError; end
+#   # Your code goes here...
+# end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: api_record
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Takuya Nishio
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.2'
+description: Write a longer description or delete this line.
+email:
+- littlecub240@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/api_record.rb
+- lib/api_record/all.rb
+- lib/api_record/base.rb
+- lib/api_record/destroyable.rb
+- lib/api_record/errors.rb
+- lib/api_record/findable.rb
+- lib/api_record/index_collection.rb
+- lib/api_record/indexable.rb
+- lib/api_record/relation.rb
+- lib/api_record/saveable.rb
+- lib/api_record/version.rb
+homepage: https://github.com/webuilder240/api_record
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/webuilder240/api_record
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.32
+signing_key: 
+specification_version: 4
+summary: Write a short summary, because RubyGems requires one.
+test_files: []