dynamodb_record 0.0.1

data/lib/dynamodb_record/query.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module DynamodbRecord
+  # Query Module
+  module Query
+    extend ActiveSupport::Concern
+
+    # Module that provides class methods for queries against the DynamoDB database.
+    module ClassMethods
+      def all(opts = {})
+        options = default_options
+        options.merge!(opts.slice(:limit))
+        response = client.scan(options)
+        DynamodbRecord::Collection.new(response, self)
+      end
+
+      # search table
+      # @param opts [Hash] Limit of record and exclusive_start_key
+      def where(opts = {})
+        limit = opts.delete(:limit)
+        exclusive_start_key = opts.delete(:exclusive_start_key)
+
+        expression_attribute_names = {}
+        expression_attribute_values = {}
+        filter_expression = ''
+        opts.each do |key, value|
+          expression_attribute_names["##{key}".to_sym] = key.to_s
+          expression_attribute_values[":#{key}"] = value
+          filter_expression << if filter_expression.empty?
+                                 "##{key} = :#{key}"
+                               else
+                                 " And ##{key} = :#{key}"
+                               end
+        end
+
+        options = default_options
+        options.merge!(limit:) if limit
+        options.merge!(expression_attribute_names:) if expression_attribute_names.present?
+        options.merge!(expression_attribute_values:) if expression_attribute_values.present?
+        options.merge!(filter_expression:) if filter_expression.present?
+        if exclusive_start_key.present?
+          json_string_decode = Base64.urlsafe_decode64(exclusive_start_key)
+          decode = JSON.parse(json_string_decode)
+          options.merge!(exclusive_start_key: decode)
+        end
+        DynamodbRecord::Collection.new(client.scan(options), self)
+      end
+    end
+  end
+end

data/lib/dynamodb_record/version.rb

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

data/lib/dynamodb_record.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'securerandom'
+require 'active_support'
+require 'active_support/concern'
+require 'active_support/core_ext'
+
+require 'aws-sdk-dynamodb'
+
+require 'dynamodb_record/version'
+require 'dynamodb_record/config'
+require 'dynamodb_record/collection'
+require 'dynamodb_record/fields'
+require 'dynamodb_record/persistence'
+require 'dynamodb_record/associations'
+require 'dynamodb_record/finders'
+require 'dynamodb_record/query'
+require 'dynamodb_record/document'
+
+module DynamodbRecord
+  extend self
+
+  def configure
+    block_given? ? yield(DynamodbRecord::Config) : DynamodbRecord::Config
+  end
+  alias config configure
+end

data/spec/app/models/person.rb

@@ -0,0 +1,7 @@
+class Person
+  include DynamodbRecord::Document
+
+  field :name, :string
+  field :activated, :boolean
+  field :created_at, :datetime
+end

data/spec/app/models/user.rb

@@ -0,0 +1,5 @@
+class User
+  include DynamodbRecord::Document
+
+  field :balance, :integer, default: 0
+end

data/spec/dynamodb_record/document_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+RSpec.describe DynamodbRecord::Document do
+  it 'initializes a new document' do
+    class Person
+      include DynamodbRecord::Document
+    end
+    person = Person.new
+    expect(person.new_record).to be_truthy
+    expect(person.attributes).to be_empty
+  end
+
+  # it 'initializes from database', :vcr do
+  #   user = User.find('hguzman10@gmail.com')
+  #   expect(user.new_record).to be_falsy
+  # end
+
+  it 'raises error on unknown field' do
+    expect { User.new({ unknown_field: 'unknown' }) }.to raise_error(NoMethodError)
+  end
+
+  it 'can ignore unknown field' do
+    expect { User.new({ unknown_field: 'unknown' }, true) }.to_not raise_error(NoMethodError)
+  end
+end

data/spec/dynamodb_record/fields_spec.rb

@@ -0,0 +1,101 @@
+require 'spec_helper'
+
+RSpec.describe DynamodbRecord::Fields do
+  it 'has default id primary key field' do
+    user = User.new
+    expect(user.id).to be_nil
+  end
+
+  it 'accepts adding fields' do
+    class Employee
+      include DynamodbRecord::Document
+
+      field :first_name, :string
+      field :last_name, :string
+    end
+    expect(Employee.attributes).to eq({ id: { type: :string, options: {} },
+                                        first_name: { type: :string, options: {} },
+                                        last_name: { type: :string, options: {} } })
+  end
+
+  it 'accepts default value' do
+    class City
+      include DynamodbRecord::Document
+
+      field :population, :integer, default: 0
+    end
+
+    expect(City.new.population).to eq(0)
+  end
+
+  it 'coearce field to its data type when intializing' do
+    class Record
+      include DynamodbRecord::Document
+
+      field :integer_field, :integer
+      field :big_decimal_field, :big_decimal
+      field :datetime_field, :datetime
+      field :boolean_field, :boolean
+    end
+
+    expect(Record.new(integer_field: '1').integer_field).to be_a(Integer)
+    expect(Record.new(big_decimal_field: '1').big_decimal_field).to be_a(BigDecimal)
+    expect(Record.new(datetime_field: '2014-12-25T04:08:25Z').datetime_field).to eq(DateTime.parse('2014-12-25T04:08:25Z'))
+    expect(Record.new(boolean_field: 'true').boolean_field).to be_truthy
+  end
+
+  it 'coearce field to its data type when calling writer' do
+    person = Person.new
+    person.created_at = '2015-01-23T04:27:21Z'
+    expect(person.created_at).to eq(DateTime.parse('2015-01-23T04:27:21Z'))
+  end
+
+  describe 'predicate method' do
+    specify { expect(Person.new(activated: false).activated?).to be_falsy }
+    specify { expect(Person.new(activated: true).activated?).to be_truthy }
+    specify { expect(Person.new(activated: 'true').activated?).to be_truthy }
+    specify { expect(Person.new(activated: 'false').activated?).to be_falsy }
+  end
+
+  describe '#unload' do
+    it 'unloads DateTime into String' do
+      now = DateTime.now
+      attrs = Person.unload({ created_at: now })
+      expect(attrs[:created_at]).to eq(now.iso8601)
+    end
+  end
+
+  describe '#attributes=' do
+    it 'set attributes from hash' do
+      person = Person.new(name: 'A Person', activated: true)
+      person.attributes = { name: 'Updated Person', activated: false }
+      expect(person.name).to eq('Updated Person')
+      expect(person.activated).to eq(false)
+    end
+  end
+
+  describe 'keys' do
+    it 'returns table\'s range key' do
+      class ThreadKey
+        include DynamodbRecord::Document
+
+        field :subject, :string, range_key: true
+      end
+
+      expect(ThreadKey.range_key).to eq(:subject)
+    end
+  end
+
+  describe 'index' do
+    it 'returns table\'s secondary index' do
+      class ThreadKey
+        include DynamodbRecord::Document
+
+        field :name, :string, hash_key: true
+        field :subject, :string, index: true
+      end
+
+      expect(ThreadKey.secondary_indexes).to eq([:subject])
+    end
+  end
+end

data/spec/dynamodb_record/finders_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+RSpec.describe DynamodbRecord::Fields, :vcr do
+  describe '#find' do
+    # it 'finds record' do
+    #   user = User.find('hguzman10@gmail.com')
+    #   p user
+    #   expect(user.id).to eq('hguzman10@gmail.com')
+    #   expect(user.balance).to eq(0)
+    # end
+    #
+    # context 'when record doesn\'t exists' do
+    #   it 'returns empty object' do
+    #     user = User.find('not here')
+    #     expect(user).to be_nil
+    #   end
+    # end
+  end
+end

data/spec/fixtures/vcr_cassettes/DynamodbRecord_Document/initializes_from_database.yml

@@ -0,0 +1,54 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://localhost:8000/
+    body:
+      encoding: UTF-8
+      string: '{"TableName":"users","Key":{"id":{"S":"hguzman10@gmail.com"}}}'
+    headers:
+      Accept-Encoding:
+      - ''
+      Content-Type:
+      - application/x-amz-json-1.0
+      X-Amz-Target:
+      - DynamoDB_20120810.GetItem
+      User-Agent:
+      - aws-sdk-ruby3/3.191.3 ua/2.0 api/dynamodb#1.105.0 os/macos#20 md/x86_64 lang/ruby#3.2.3
+        md/3.2.3 cfg/retry-mode#legacy
+      Host:
+      - localhost:8000
+      X-Amz-Date:
+      - 20240418T230852Z
+      X-Amz-Content-Sha256:
+      - 7e2248df156bd85d1c08add1aaa7b84ed6041fe96165fb6879ddbb1424663802
+      Authorization:
+      - AWS4-HMAC-SHA256 Credential=AKIAV3OBKSDM5UO5PK5A/20240418/us-east-1/dynamodb/aws4_request,
+        SignedHeaders=content-type;host;x-amz-content-sha256;x-amz-date;x-amz-target,
+        Signature=a6e8d3a4fbfcc98091bff89a3d492337c072c486ea0a1d05c6ee45d69ff0834f
+      Content-Length:
+      - '62'
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Thu, 18 Apr 2024 23:08:52 GMT
+      X-Amzn-Requestid:
+      - 2905a9b7-87da-494c-ba16-3d26a0e3df6b
+      Content-Type:
+      - application/x-amz-json-1.0
+      X-Amz-Crc32:
+      - '3745271733'
+      Content-Length:
+      - '63'
+      Server:
+      - Jetty(11.0.17)
+    body:
+      encoding: UTF-8
+      string: '{"Item":{"balance":{"N":"0"},"id":{"S":"hguzman10@gmail.com"}}}'
+  recorded_at: Thu, 18 Apr 2024 23:08:52 GMT
+recorded_with: VCR 6.2.0

data/spec/fixtures/vcr_cassettes/DynamodbRecord_Fields/_find/finds_record.yml

@@ -0,0 +1,54 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://localhost:8000/
+    body:
+      encoding: UTF-8
+      string: '{"TableName":"users","Key":{"id":{"S":"hguzman10@gmail.com"}}}'
+    headers:
+      Accept-Encoding:
+      - ''
+      Content-Type:
+      - application/x-amz-json-1.0
+      X-Amz-Target:
+      - DynamoDB_20120810.GetItem
+      User-Agent:
+      - aws-sdk-ruby3/3.191.3 ua/2.0 api/dynamodb#1.105.0 os/macos#20 md/x86_64 lang/ruby#3.2.3
+        md/3.2.3 cfg/retry-mode#legacy
+      Host:
+      - localhost:8000
+      X-Amz-Date:
+      - 20240419T150314Z
+      X-Amz-Content-Sha256:
+      - 7e2248df156bd85d1c08add1aaa7b84ed6041fe96165fb6879ddbb1424663802
+      Authorization:
+      - AWS4-HMAC-SHA256 Credential=AKIAV3OBKSDM5UO5PK5A/20240419/us-east-1/dynamodb/aws4_request,
+        SignedHeaders=content-type;host;x-amz-content-sha256;x-amz-date;x-amz-target,
+        Signature=eabad8cbbf72dd69908f08a4144d979c1287ad246a253639c311a2ddda0ae2df
+      Content-Length:
+      - '62'
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Fri, 19 Apr 2024 15:03:14 GMT
+      X-Amzn-Requestid:
+      - 8dff3212-b275-4948-a0ff-197f620c2344
+      Content-Type:
+      - application/x-amz-json-1.0
+      X-Amz-Crc32:
+      - '3745271733'
+      Content-Length:
+      - '63'
+      Server:
+      - Jetty(11.0.17)
+    body:
+      encoding: UTF-8
+      string: '{"Item":{"balance":{"N":"0"},"id":{"S":"hguzman10@gmail.com"}}}'
+  recorded_at: Fri, 19 Apr 2024 15:03:14 GMT
+recorded_with: VCR 6.2.0

data/spec/fixtures/vcr_cassettes/DynamodbRecord_Fields/_find/when_record_doesn_t_exists/returns_empty_object.yml

@@ -0,0 +1,54 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://localhost:8000/
+    body:
+      encoding: UTF-8
+      string: '{"TableName":"users","Key":{"id":{"S":"not here"}}}'
+    headers:
+      Accept-Encoding:
+      - ''
+      Content-Type:
+      - application/x-amz-json-1.0
+      X-Amz-Target:
+      - DynamoDB_20120810.GetItem
+      User-Agent:
+      - aws-sdk-ruby3/3.191.3 ua/2.0 api/dynamodb#1.105.0 os/macos#20 md/x86_64 lang/ruby#3.2.3
+        md/3.2.3 cfg/retry-mode#legacy
+      Host:
+      - localhost:8000
+      X-Amz-Date:
+      - 20240419T150314Z
+      X-Amz-Content-Sha256:
+      - acbe242b07a1de9c8a8ac78119a8da7e4bf1d57c7d59ed18930d06ad600c9d6c
+      Authorization:
+      - AWS4-HMAC-SHA256 Credential=AKIAV3OBKSDM5UO5PK5A/20240419/us-east-1/dynamodb/aws4_request,
+        SignedHeaders=content-type;host;x-amz-content-sha256;x-amz-date;x-amz-target,
+        Signature=47085d1e327831fd245c6c4e369ab311a42ec360f91eb745820dec01bafc46d5
+      Content-Length:
+      - '51'
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Fri, 19 Apr 2024 15:03:14 GMT
+      X-Amzn-Requestid:
+      - cbb6dfa5-b168-48ab-a3d6-64eca11dbc6e
+      Content-Type:
+      - application/x-amz-json-1.0
+      X-Amz-Crc32:
+      - '2745614147'
+      Content-Length:
+      - '2'
+      Server:
+      - Jetty(11.0.17)
+    body:
+      encoding: UTF-8
+      string: "{}"
+  recorded_at: Fri, 19 Apr 2024 15:03:14 GMT
+recorded_with: VCR 6.2.0

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'dynamodb_record'
+
+MODELS = File.join(File.dirname(__FILE__), 'app/models')
+Dir[File.join(MODELS, '*.rb')].sort.each { |file| require file }
+
+require 'vcr'
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/fixtures/vcr_cassettes'
+  c.hook_into :webmock
+  c.configure_rspec_metadata!
+  c.default_cassette_options = { match_requests_on: %i[method uri body] }
+end
+
+DynamodbRecord.configure do |config|
+  config.namespace = nil
+  config.endpoint = 'http://localhost:8000'
+end

metadata

@@ -0,0 +1,225 @@
+--- !ruby/object:Gem::Specification
+name: dynamodb_record
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Henry Guzman
+- Jhon Santander
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-04-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.3.2
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-dynamodb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.105'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.105'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-sqs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.70'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.70'
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.8.1
+- !ruby/object:Gem::Dependency
+  name: rexml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.6
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.62'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.62'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.2'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.23'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.23'
+description:
+email:
+- hguzman10@gmail.com
+- jsantander1219@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".ruby-version"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- dynamodb_record.gemspec
+- lib/dynamodb_record.rb
+- lib/dynamodb_record/associations.rb
+- lib/dynamodb_record/collection.rb
+- lib/dynamodb_record/config.rb
+- lib/dynamodb_record/document.rb
+- lib/dynamodb_record/fields.rb
+- lib/dynamodb_record/finders.rb
+- lib/dynamodb_record/persistence.rb
+- lib/dynamodb_record/query.rb
+- lib/dynamodb_record/version.rb
+- spec/app/models/person.rb
+- spec/app/models/user.rb
+- spec/dynamodb_record/document_spec.rb
+- spec/dynamodb_record/fields_spec.rb
+- spec/dynamodb_record/finders_spec.rb
+- spec/fixtures/vcr_cassettes/DynamodbRecord_Document/initializes_from_database.yml
+- spec/fixtures/vcr_cassettes/DynamodbRecord_Fields/_find/finds_record.yml
+- spec/fixtures/vcr_cassettes/DynamodbRecord_Fields/_find/when_record_doesn_t_exists/returns_empty_object.yml
+- spec/spec_helper.rb
+homepage: https://github.com/CarsOk/dynamodb-record
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: A simple DynamoDB ORM
+test_files:
+- spec/app/models/person.rb
+- spec/app/models/user.rb
+- spec/dynamodb_record/document_spec.rb
+- spec/dynamodb_record/fields_spec.rb
+- spec/dynamodb_record/finders_spec.rb
+- spec/fixtures/vcr_cassettes/DynamodbRecord_Document/initializes_from_database.yml
+- spec/fixtures/vcr_cassettes/DynamodbRecord_Fields/_find/finds_record.yml
+- spec/fixtures/vcr_cassettes/DynamodbRecord_Fields/_find/when_record_doesn_t_exists/returns_empty_object.yml
+- spec/spec_helper.rb