rock_rms 4.0.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a826c9dad155cd2dde1432bcf622307375bc5e16
-  data.tar.gz: e5053d52043a7c4b7bc5e8a8089c4abc8623b2a9
+  metadata.gz: ed6a5d3502d7ae87cf56e2878a156176052aab6e
+  data.tar.gz: 0ff8631bc4df0fbc08a00baffe6b80d849a75caf
 SHA512:
-  metadata.gz: abfce0335816d7d9ec0235fd08424781b75287a13c68acbfd86d4d6bd3c3dd365adafbc013eab222dfb3eb25080466249d8df999a0d57a31190a551b46ddeab2
-  data.tar.gz: 11c7835281d1a541223d726125032d1508a40a054a2d25a659204f5396f8f591972c849a0fd33290c597b936b79a850b57a690faff3319e972d7554ab2d2f09d
+  metadata.gz: b9003d89888260cf0b0def946934ad0d87c8ec919ef353afb602ca6f8be0ee99faddd06ef33a26d5c9bc052b546cf84e1dee829dbfa33f7756097b342f125fa0
+  data.tar.gz: f4c08be6dd30bbd212a3edc0c85d4dba31693d5d8cd0acad9e8f582c14f6bb9be380567893d300406fe84075157a2f2f2db4aaba1c2137a5134a1ccc4f5aebf0

data/README.md

@@ -14,7 +14,7 @@ I'm a big fan of Rock so if you have problems using the gem or would like to see
 Add this line to your application's Gemfile:
 ````ruby
   # in your Gemfile
-  gem 'rock_rms', '~> 4.0'
+  gem 'rock_rms', '~> 4.1'
 
   # then...
   bundle install

data/lib/rock_rms/client.rb

@@ -8,6 +8,8 @@ Dir[File.expand_path('../response/*.rb', __FILE__)].each { |f| require f }
 
 module RockRMS
   class Client
+    include RockRMS::Client::Attribute
+    include RockRMS::Client::AttributeValue
     include RockRMS::Client::Batch
     include RockRMS::Client::Fund
     include RockRMS::Client::Campus

data/lib/rock_rms/resources/attribute.rb

@@ -0,0 +1,37 @@
+module RockRMS
+  class Client
+    module Attribute
+      def list_attributes(options = {})
+        Response::Attribute.format(
+          get(attributes_path, options)
+        )
+      end
+
+      def create_attribute(
+        description: nil,
+        field_type_id:,
+        entity_type_id:,
+        key:,
+        name:,
+        order: Random.rand(100..1000)
+      )
+        options = {
+          'FieldTypeId'  => field_type_id,
+          'EntityTypeId' => entity_type_id,
+          'Key'          => key,
+          'Name'         => name,
+          'Description'  => description,
+          'Order'        => order
+        }
+
+        post(attributes_path, options)
+      end
+
+      private
+
+      def attributes_path
+        'Attributes'.freeze
+      end
+    end
+  end
+end

data/lib/rock_rms/resources/attribute_value.rb

@@ -0,0 +1,28 @@
+module RockRMS
+  class Client
+    module AttributeValue
+      def list_attribute_values(options = {})
+        Response::AttributeValue.format(
+          get(attribute_values_path, options)
+        )
+      end
+
+      def create_attribute_value(attribute_id:, entity_id:, value:)
+        options = {
+          'AttributeId' => attribute_id,
+          'EntityId'    => entity_id,
+          'Value'       => value,
+          'IsSystem'    => false
+        }
+
+        post(attribute_values_path, options)
+      end
+
+      private
+
+      def attribute_values_path
+        'AttributeValues'.freeze
+      end
+    end
+  end
+end

data/lib/rock_rms/response/attribute.rb

@@ -0,0 +1,16 @@
+module RockRMS
+  module Response
+    class Attribute < Base
+      MAP = {
+        id: 'Id',
+        name: 'Name',
+        key: 'Key',
+        description: 'Description'
+      }.freeze
+
+      def format_single(data)
+        to_h(MAP, data)
+      end
+    end
+  end
+end

data/lib/rock_rms/response/attribute_value.rb

@@ -0,0 +1,16 @@
+module RockRMS
+  module Response
+    class AttributeValue < Base
+      MAP = {
+        id: 'Id',
+        value: 'Value',
+        value_as_number: 'ValueAsNumeric',
+        entity_id: 'EntityId'
+      }.freeze
+
+      def format_single(data)
+        to_h(MAP, data)
+      end
+    end
+  end
+end

data/lib/rock_rms/version.rb

@@ -1,3 +1,3 @@
 module RockRMS
-  VERSION = '4.0.0'.freeze
+  VERSION = '4.1.0'.freeze
 end

data/spec/rock_rms/resources/attribute_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+RSpec.describe RockRMS::Client::Attribute, type: :model do
+  include_context 'resource specs'
+
+  describe '#list_attributes' do
+    it 'returns a array' do
+      resource = client.list_attributes
+      expect(resource).to be_a(Array)
+      expect(resource.first).to be_a(Hash)
+    end
+  end
+
+  describe '#create_attribute' do
+    context 'arguments' do
+      it 'require `field_type_id`' do
+        expect { client.create_attribute }
+          .to raise_error(ArgumentError, /field_type_id/)
+      end
+
+      it 'require `entity_type_id`' do
+        expect { client.create_attribute }
+          .to raise_error(ArgumentError, /entity_type_id/)
+      end
+
+      it 'require `key`' do
+        expect { client.create_attribute }
+          .to raise_error(ArgumentError, /key/)
+      end
+
+      it 'require `name`' do
+        expect { client.create_attribute }
+          .to raise_error(ArgumentError, /name/)
+      end
+    end
+
+    subject(:resource) do
+      client.create_attribute(
+        key: 'TransactionFee',
+        name: 'Transaction Fee',
+        entity_type_id: 85,
+        field_type_id: 14,
+        description: 'Transaction fees for a specific gateway',
+        order: 1234
+      )
+    end
+
+    it 'returns integer' do
+      expect(resource).to be_a(Integer)
+    end
+
+    it 'passes options' do
+      expect(client).to receive(:post)
+        .with(
+          'Attributes',
+          'FieldTypeId' => 14,
+          'EntityTypeId' => 85,
+          'Key' => 'TransactionFee',
+          'Name' => 'Transaction Fee',
+          'Description' => 'Transaction fees for a specific gateway',
+          'Order' => 1234
+        )
+        .and_call_original
+      resource
+    end
+  end
+end

data/spec/rock_rms/resources/attribute_values_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+RSpec.describe RockRMS::Client::AttributeValue, type: :model do
+  include_context 'resource specs'
+
+  describe '#list_attribute_values' do
+    it 'returns a array' do
+      resource = client.list_attribute_values
+      expect(resource).to be_a(Array)
+      expect(resource.first).to be_a(Hash)
+    end
+  end
+
+  describe '#create_attribute_value' do
+    context 'arguments' do
+      it 'require `attribute_id`' do
+        expect { client.create_attribute_value }
+          .to raise_error(ArgumentError, /attribute_id/)
+      end
+
+      it 'require `entity_id`' do
+        expect { client.create_attribute_value }
+          .to raise_error(ArgumentError, /entity_id/)
+      end
+
+      it 'require `value`' do
+        expect { client.create_attribute_value }
+          .to raise_error(ArgumentError, /value/)
+      end
+    end
+
+    subject(:resource) do
+      client.create_attribute_value(
+        attribute_id: 12993,
+        entity_id: 731,
+        value: 100
+      )
+    end
+
+    it 'returns integer' do
+      expect(resource).to be_a(Integer)
+    end
+
+    it 'passes options' do
+      expect(client).to receive(:post)
+        .with(
+          'AttributeValues',
+          'AttributeId' => 12993,
+          'EntityId'    => 731,
+          'Value'       => 100,
+          'IsSystem'    => false
+        )
+        .and_call_original
+      resource
+    end
+  end
+end

data/spec/rock_rms/response/attribute_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+RSpec.describe RockRMS::Response::Attribute, type: :model do
+  let(:parsed) { JSON.parse(FixturesHelper.read('attributes.json')) }
+
+  describe '.format' do
+    subject(:result) { described_class.format(parsed) }
+
+    context 'when response is array' do
+      it 'returns an array' do
+        expect(described_class.format([])).to be_a(Array)
+      end
+    end
+
+    it 'translates keys' do
+      result.zip(parsed) do |r, p|
+        expect(r[:id]).to eq(p['Id'])
+        expect(r[:name]).to eq(p['Name'])
+        expect(r[:key]).to eq(p['Key'])
+        expect(r[:description]).to eq(p['Description'])
+      end
+    end
+  end
+end

data/spec/rock_rms/response/attribute_value_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+RSpec.describe RockRMS::Response::AttributeValue, type: :model do
+  let(:parsed) { JSON.parse(FixturesHelper.read('attribute_values.json')) }
+
+  describe '.format' do
+    subject(:result) { described_class.format(parsed) }
+
+    context 'when response is array' do
+      it 'returns an array' do
+        expect(described_class.format([])).to be_a(Array)
+      end
+    end
+
+    it 'has the correct number keys' do
+      keys = result.first.keys
+      expect(keys.count).to eq(4)
+    end
+
+    it 'translates keys' do
+      result.zip(parsed) do |r, p|
+        expect(r[:id]).to eq(p['Id'])
+        expect(r[:value]).to eq(p['Value'])
+        expect(r[:value_as_number]).to eq(p['ValueAsNumeric'])
+        expect(r[:entity_id]).to eq(p['EntityId'])
+      end
+    end
+  end
+end

data/spec/support/fixtures/attribute_values.json

@@ -0,0 +1,17 @@
+[
+  {
+    "IsSystem": false,
+    "AttributeId": 12993,
+    "EntityId": 731,
+    "Value": "23",
+    "ValueAsNumeric": 23.0000,
+    "ValueAsBoolean": false,
+    "CreatedDateTime": "2018-04-13T07:22:23.723",
+    "ModifiedDateTime": "2018-04-13T07:22:23.723",
+    "CreatedByPersonAliasId": 1,
+    "ModifiedByPersonAliasId": 1,
+    "ModifiedAuditValuesAlreadyUpdated": false,
+    "Id": 11615,
+    "Guid": "70d06b09-97cd-4788-9667-6f0b11dcde70"
+  }
+]

data/spec/support/fixtures/attributes.json

@@ -0,0 +1,38 @@
+[
+  {
+    "IsSystem": false,
+    "FieldTypeId": 14,
+    "EntityTypeId": 85,
+    "EntityTypeQualifierColumn": "",
+    "EntityTypeQualifierValue": "",
+    "Key": "TransactionFee",
+    "Name": "Transaction Fee",
+    "Description": "",
+    "Order": 1001,
+    "IsGridColumn": false,
+    "DefaultValue": "",
+    "IsMultiValue": false,
+    "IsRequired": false,
+    "IconCssClass": "",
+    "AllowSearch": false,
+    "IsIndexEnabled": false,
+    "IsAnalytic": false,
+    "IsAnalyticHistory": false,
+    "EntityType": null,
+    "AttributeQualifiers": [],
+    "FieldType": null,
+    "Categories": [],
+    "CreatedDateTime": "2018-04-13T07:01:36.123",
+    "ModifiedDateTime": "2018-04-13T07:01:36.123",
+    "CreatedByPersonAliasId": 1,
+    "ModifiedByPersonAliasId": 1,
+    "ModifiedAuditValuesAlreadyUpdated": false,
+    "Attributes": null,
+    "AttributeValues": null,
+    "Id": 12993,
+    "Guid": "35a283dd-f411-427a-9296-da37007efe93",
+    "ForeignId": null,
+    "ForeignGuid": null,
+    "ForeignKey": null
+  }
+]

data/spec/support/fixtures/create_attribute.json

@@ -0,0 +1 @@
+12345

data/spec/support/fixtures/create_attribute_value.json

@@ -0,0 +1 @@
+12345

data/spec/support/rock_mock.rb

@@ -19,6 +19,8 @@ class RockMock < Sinatra::Base
 
   # GET requests
   {
+    attributes:    'Attributes',
+    attribute_values: 'AttributeValues',
     batch:         'FinancialBatches/:id',
     batches:       'FinancialBatches',
     campus:        'Campuses/:id',
@@ -46,6 +48,8 @@ class RockMock < Sinatra::Base
 
   # POST requests
   {
+    create_attribute: 'Attributes',
+    create_attribute_value: 'AttributeValues',
     create_group_member: 'GroupMembers',
     create_transaction: 'FinancialTransactions',
     create_payment_detail: 'FinancialPaymentDetails',

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rock_rms
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.1.0
 platform: ruby
 authors:
 - Taylor Brooks
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-11 00:00:00.000000000 Z
+date: 2018-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -184,6 +184,8 @@ files:
 - lib/rock_rms.rb
 - lib/rock_rms/client.rb
 - lib/rock_rms/error.rb
+- lib/rock_rms/resources/attribute.rb
+- lib/rock_rms/resources/attribute_value.rb
 - lib/rock_rms/resources/batch.rb
 - lib/rock_rms/resources/campus.rb
 - lib/rock_rms/resources/fund.rb
@@ -199,6 +201,8 @@ files:
 - lib/rock_rms/resources/saved_payment_method.rb
 - lib/rock_rms/resources/transaction.rb
 - lib/rock_rms/resources/transaction_detail.rb
+- lib/rock_rms/response/attribute.rb
+- lib/rock_rms/response/attribute_value.rb
 - lib/rock_rms/response/base.rb
 - lib/rock_rms/response/batch.rb
 - lib/rock_rms/response/campus.rb
@@ -220,6 +224,8 @@ files:
 - rock_rms.gemspec
 - spec/rock_rms/client_spec.rb
 - spec/rock_rms/error_spec.rb
+- spec/rock_rms/resources/attribute_spec.rb
+- spec/rock_rms/resources/attribute_values_spec.rb
 - spec/rock_rms/resources/batch_spec.rb
 - spec/rock_rms/resources/campus_spec.rb
 - spec/rock_rms/resources/gateway_spec.rb
@@ -234,6 +240,8 @@ files:
 - spec/rock_rms/resources/saved_payment_method_spec.rb
 - spec/rock_rms/resources/transaction_detail_spec.rb
 - spec/rock_rms/resources/transaction_spec.rb
+- spec/rock_rms/response/attribute_spec.rb
+- spec/rock_rms/response/attribute_value_spec.rb
 - spec/rock_rms/response/batch_spec.rb
 - spec/rock_rms/response/campus_spec.rb
 - spec/rock_rms/response/group_location_spec.rb
@@ -248,10 +256,14 @@ files:
 - spec/rock_rms_spec.rb
 - spec/spec_helper.rb
 - spec/support/client_factory.rb
+- spec/support/fixtures/attribute_values.json
+- spec/support/fixtures/attributes.json
 - spec/support/fixtures/batch.json
 - spec/support/fixtures/batches.json
 - spec/support/fixtures/campus.json
 - spec/support/fixtures/campuses.json
+- spec/support/fixtures/create_attribute.json
+- spec/support/fixtures/create_attribute_value.json
 - spec/support/fixtures/create_batch.json
 - spec/support/fixtures/create_group_member.json
 - spec/support/fixtures/create_payment_detail.json