arkenstone-open 3.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8d733a53e57cd9f59167299cedd91ee37b83060f62a18afeaf8d79d9b3b4184a
+  data.tar.gz: 9d68710e72885419899b52471cdd8cc09e9725bbe940f56a17e500d6207f7b45
+SHA512:
+  metadata.gz: db74e65147e8d87b57a6a90cde59eca88651a87882846eecf04d038777fa69c1b76bf07d84757c77e3d32b5b81a0b66875a831d41d1809f5f568d758306cb38e
+  data.tar.gz: 756ae9b10fce7f54d5487e8215a82ef186318f720977af6488041a18235cc3ec53b09767871f981ed5f7b2a88bfe468a54913b69a4f6adfe8ed06ca817715c64

data/.github/workflows/codacy-analysis.yml

@@ -0,0 +1,46 @@
+# This workflow checks out code, performs a Codacy security scan
+# and integrates the results with the
+# GitHub Advanced Security code scanning feature.  For more information on
+# the Codacy security scan action usage and parameters, see
+# https://github.com/codacy/codacy-analysis-cli-action.
+# For more information on Codacy Analysis CLI in general, see
+# https://github.com/codacy/codacy-analysis-cli.
+
+name: Codacy Security Scan
+
+on:
+  push:
+    branches: ["development", "main"]
+  pull_request:
+    branches: ["development", "main"]
+
+jobs:
+  codacy-security-scan:
+    name: Codacy Security Scan
+    runs-on: ubuntu-latest
+    steps:
+      # Checkout the repository to the GitHub Actions runner
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      # Execute Codacy Analysis CLI and generate a SARIF output with the security issues identified during the analysis
+      - name: Run Codacy Analysis CLI
+        uses: codacy/codacy-analysis-cli-action@1.1.0
+        with:
+          # Check https://github.com/codacy/codacy-analysis-cli#project-token to get your project token from your Codacy repository
+          # You can also omit the token and run the tools that support default configurations
+          project-token: ${{ secrets.CODACY_PROJECT_TOKEN }}
+          verbose: true
+          output: results.sarif
+          format: sarif
+          # Adjust severity of non-security issues
+          gh-code-scanning-compat: true
+          # Force 0 exit code to allow SARIF file generation
+          # This will handover control about PR rejection to the GitHub side
+          max-allowed-issues: 2147483647
+
+      # Upload the SARIF file generated in the previous step
+      - name: Upload SARIF results file
+        uses: github/codeql-action/upload-sarif@v1
+        with:
+          sarif_file: results.sarif

data/.gitignore

@@ -0,0 +1,19 @@
+*.DS_Store
+*.gem
+*.rbc
+*.swp
+*.swo
+.bundle
+.config
+.yardoc
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rubocop.yml

@@ -0,0 +1,5 @@
+AllCops:
+  NewCops: enable
+Lint/MissingSuper:
+  Exclude:
+    - lib/arkenstone/enumerable/query_list.rb

data/.ruby-version

@@ -0,0 +1 @@
+3.1.2

data/.travis.yml

@@ -0,0 +1,16 @@
+dist: focal
+env:
+  global:
+    - CC_TEST_REPORTER_ID=8d9ccf963273f583d380d4e2b97da731c25d77bb4784151ea4a6ec27bbbdaf22
+language: ruby
+rvm:
+  - 3.0.2
+branches:
+  except:
+    - documentation
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/Gemfile

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+group :test do
+  gem 'minitest'
+  gem 'pry'
+  gem 'pry-nav'
+  gem 'simplecov', require: false
+  gem 'test-unit' # test-unit was removed from ruby in version 2.2.0
+  gem 'webmock', '~> 3.9.3'
+end
+
+group :development do
+  gem 'flog'
+  gem 'rubocop'
+  gem 'yard'
+end
+
+# Specify your gem's dependencies in arkenstone.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,101 @@
+PATH
+  remote: .
+  specs:
+    arkenstone (3.0.0)
+      activesupport (>= 5.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.0.4.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    coderay (1.1.3)
+    concurrent-ruby (1.2.2)
+    crack (0.4.5)
+      rexml
+    docile (1.4.0)
+    flog (4.6.6)
+      path_expander (~> 1.0)
+      ruby_parser (~> 3.1, > 3.1.0)
+      sexp_processor (~> 4.8)
+    hashdiff (1.0.1)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    json (2.6.3)
+    method_source (1.0.0)
+    minitest (5.18.0)
+    parallel (1.22.1)
+    parser (3.2.1.1)
+      ast (~> 2.4.1)
+    path_expander (1.1.1)
+    power_assert (2.0.3)
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-nav (1.0.0)
+      pry (>= 0.9.10, < 0.15)
+    public_suffix (5.0.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.7.0)
+    rexml (3.2.5)
+    rubocop (1.48.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.26.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.27.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    ruby_parser (3.20.0)
+      sexp_processor (~> 4.16)
+    sexp_processor (4.16.1)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    test-unit (3.5.7)
+      power_assert
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.4.2)
+    webmock (3.9.5)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    webrick (1.7.0)
+    yard (0.9.28)
+      webrick (~> 1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  arkenstone!
+  bundler (>= 2.1)
+  flog
+  minitest
+  pry
+  pry-nav
+  rake (>= 13.0.1)
+  rubocop
+  simplecov
+  test-unit
+  webmock (~> 3.9.3)
+  yard
+
+BUNDLED WITH
+   2.2.22

data/LICENSE.txt

@@ -0,0 +1,11 @@
+The MIT License (MIT)
+
+Arkenstone: a lightweight json active model like framework.
+
+Copyright (C) 2020 Michael Christenson II
+
+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,87 @@
+# Arkenstone [![Build Status](https://app.travis-ci.com/m3talsmith/arkenstone.svg?branch=development&status=passed)](https://app.travis-ci.com/m3talsmith/arkenstone) [![Maintainability](https://api.codeclimate.com/v1/badges/a0f3b07d272fcf220475/maintainability)](https://codeclimate.com/github/m3talsmith/arkenstone/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/a0f3b07d272fcf220475/test_coverage)](https://codeclimate.com/github/m3talsmith/arkenstone/test_coverage)
+
+Arkenstone is a replacement for [ActiveRecord](http://api.rubyonrails.org/classes/ActiveRecord/Base.html) that uses RESTful services to get and store data.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'arkenstone'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install arkenstone
+
+## Usage
+
+Include the `Arkenstone::Document` module in your class, set the `url` and `attributes` and away you go.
+
+    class User
+      include Arkenstone::Document
+
+      url 'http://example.com/users/'
+      attributes :name, :age, :gender
+    end
+
+`User` instances will have accessor properties for `:name`, `:age`, and `:gender`. You can also `save`, and `update_attributes` as well:
+
+    my_user = User.create(name: 'Thorin', age: 195, gender: 'M', bearded: true)
+
+This will make a `POST` to `http://example.com/users/`. If json data is returned from the server, it will be applied to the attributes of the object.
+
+How about updating?
+
+    # Assuming Thorin has an id of 1
+    thorin = User.find(1)
+
+    # Thorin lost a bet and shaved... well you know how bets go!
+    thorin.update_attribute :bearded, false
+
+This does a `PUT` to `http://example.com/users/1`. Again, returning json is translated back into a usable Thorin.
+
+You can also change attributes using `#update_attributes` or setting them at a field level and saving.
+
+    # Thorin didn't shave for a day
+    thorin = User.find(1)
+    thorin.bearded = true
+    thorin.save
+
+`Arkenstone` knows if you're a new object or not and properly uses `POST` or `PUT` where needed.
+
+Here is a list of `RESTful` expectations that come with the library:
+
+```ruby
+Model.find(1)                                                               # => GET http://example.com/1
+Model.all                                                                   # => GET http://example.com
+Model.new.save                                                              # => POST http://example.com
+Model.find(1).save                                                          # => PUT http://example.com/1
+Model.find(1).update_attribute(:attribute, 'value')                         # => PUT http://example.com/1
+Model.find(1).update_attributes(attribute1: 'value1', attribute2: 'value2') # => PUT http://example.com/1
+Model.find(1).destroy                                                       # => DELETE http://example.com/1
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+The MIT License (MIT)
+
+Arkenstone: a lightweight json active model like framework.
+
+Copyright (C) 2020 Michael Christenson II
+
+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/Rakefile

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+if RUBY_VERSION.split('.')
+               .first.to_i < 3
+  abort 'Arkenstone development requires Ruby >= 3.0.2. ' \
+        'Please upgrade to a newer version of Ruby'
+end
+require 'rake/testtask'
+require './lib/arkenstone/version'
+
+task :build do
+  system 'gem build arkenstone.gemspec'
+end
+
+task package: :build do
+  system "gem push arkenstone-open-#{Arkenstone::VERSION}.gem"
+end
+
+task :analyze do
+  system 'rubocop -A'
+  system 'flog -g lib'
+end
+
+task :docs do
+  system 'yard doc'
+end
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.libs << 'test/test_associations'
+  t.verbose = false
+  t.warning = false
+end
+
+desc 'Run tests'
+task default: :test

data/arkenstone.gemspec

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'arkenstone/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'arkenstone-open'
+  spec.version       = Arkenstone::VERSION
+  spec.authors       = ['Michael Christenson II', 'Steve Young', 'Scott Williams', 'Brett Byler']
+  spec.email         = ['m3talsmith@gmail.com']
+  spec.description   = 'An Open Source ActiveRecord replacement over REST'
+  spec.summary       = 'A drop-in replacement for ActiveRecord that performs CRUD operations over RESTful URLs.'
+  spec.homepage      = 'https://github.com/m3talsmith/arkenstone'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '>= 2.1'
+  spec.add_development_dependency 'rake', '>= 13.0.1'
+  spec.add_runtime_dependency 'activesupport', '>= 5.0'
+
+  spec.required_ruby_version = '>= 3.0'
+  spec.metadata['rubygems_mfa_required'] = 'true'
+end

data/lib/arkenstone/associations/resources.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module Arkenstone
+  module Associations
+    module Resources
+      class << self
+        def included(base)
+          base.send :include, InstanceMethods
+          base.extend ClassMethods
+        end
+      end
+
+      module ClassMethods
+      end
+
+      module InstanceMethods
+        ### Attaches singleton methods for has_many relationships
+        def attach_nested_has_many_resource_methods(nested_resources, nested_resource_name,
+                                                    nested_resource_class_name = nested_resource_name)
+          parent_instance = self
+          parent_instance.extend HasManyParentSingletonMethods
+          parent_instance.add_resource_methods(nested_resource_name)
+
+          nested_klass = prefix_with_class_module(nested_resource_class_name.to_s.classify)
+          nested_klass = Kernel.const_get(nested_klass)
+          nested_klass.url build_nested_url(nested_resource_name)
+
+          nested_resources.define_singleton_method(:arkenstone_parent_instance) { parent_instance }
+          nested_resources.define_singleton_method(:arkenstone_nested_class) { nested_klass }
+          nested_resources.define_singleton_method(:arkenstone_nested_resource_name) { nested_resource_name }
+          nested_resources.extend HasManySingletonMethods
+          nested_resources
+        end
+      end
+
+      module HasManyParentSingletonMethods
+        def add_resource_methods(nested_resource_name)
+          parent_instance          = self
+          resource_name_pluralized = nested_resource_name.to_s.pluralize
+
+          parent_instance.define_singleton_method "#{resource_name_pluralized}=" do |resources|
+            resources.each do |resource|
+              resource.send "#{parent_instance.class.to_s.demodulize.downcase}_id=", parent_instance.id
+            end
+
+            parent_instance.arkenstone_data[resource_name_pluralized.to_sym] = resources
+            resources
+          end
+        end
+      end
+
+      module HasManySingletonMethods
+        def <<(resource)
+          push resource
+          arkenstone_parent_instance.send "#{arkenstone_nested_resource_name}=", self
+        end
+
+        def build(options)
+          parent_id                 = "#{arkenstone_parent_instance.class.to_s.demodulize.underscore}_id"
+          new_resource              = arkenstone_nested_class.build(options.merge({ parent_id => arkenstone_parent_instance.id }))
+          parent_resource_instances = arkenstone_parent_instance.send arkenstone_nested_resource_name.to_sym
+
+          parent_resource_instances << new_resource
+          arkenstone_parent_instance.send "#{arkenstone_nested_resource_name}=", parent_resource_instances
+
+          new_resource
+        end
+
+        def create(options)
+          new_resource = build(options)
+          new_resource.save
+        end
+      end
+    end
+  end
+end