sf_connect 0.1.1

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 1ecbcbb39d5d19bc52e64d354e3b39422af68cb8040e3bb1a9b5823542109753
4
+ data.tar.gz: 81e4fc211891bfe2908d077f6263939a220774843a2547ba9e1beba0690a2a53
5
+ SHA512:
6
+ metadata.gz: 2d35cdf68b3ffc6f3364e1090b62ed2602e281ead52bf87aef0f322f164b1ad35ebaff28e138055184db5528fb6bd2440d3df78599688e73202a80efa0891edf
7
+ data.tar.gz: 8fa8a2f9619a323b6aa162fe594c66d23348ed25bcffc022d13b68eae47c92cc0158e45caa5ea2b2e0dce9d5f15d697bf3aea2d43b42ede45b3db8479c9001a7
data/.rspec ADDED
@@ -0,0 +1,3 @@
1
+ --format documentation
2
+ --color
3
+ --require spec_helper
data/.rubocop.yml ADDED
@@ -0,0 +1,29 @@
1
+ require:
2
+ - rubocop-performance
3
+ - rubocop-rspec
4
+
5
+ AllCops:
6
+ TargetRubyVersion: 3.2
7
+ SuggestExtensions: true
8
+ DisplayCopNames: true
9
+ NewCops: enable
10
+
11
+ Style/FrozenStringLiteralComment:
12
+ Enabled: false
13
+
14
+ Style/StringLiterals:
15
+ Enabled: true
16
+ EnforcedStyle: double_quotes
17
+
18
+ Style/StringLiteralsInInterpolation:
19
+ Enabled: true
20
+ EnforcedStyle: double_quotes
21
+
22
+ Layout/LineLength:
23
+ Max: 120
24
+
25
+ RSpec/ExampleLength:
26
+ Enabled: false
27
+
28
+ RSpec/DescribedClass:
29
+ Enabled: false
data/CHANGELOG.md ADDED
@@ -0,0 +1,5 @@
1
+ ## [Unreleased]
2
+
3
+ ## [0.1.0] - 2023-10-20
4
+
5
+ - Initial release
@@ -0,0 +1,84 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
6
+
7
+ We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
8
+
9
+ ## Our Standards
10
+
11
+ Examples of behavior that contributes to a positive environment for our community include:
12
+
13
+ * Demonstrating empathy and kindness toward other people
14
+ * Being respectful of differing opinions, viewpoints, and experiences
15
+ * Giving and gracefully accepting constructive feedback
16
+ * Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
17
+ * Focusing on what is best not just for us as individuals, but for the overall community
18
+
19
+ Examples of unacceptable behavior include:
20
+
21
+ * The use of sexualized language or imagery, and sexual attention or
22
+ advances of any kind
23
+ * Trolling, insulting or derogatory comments, and personal or political attacks
24
+ * Public or private harassment
25
+ * Publishing others' private information, such as a physical or email
26
+ address, without their explicit permission
27
+ * Other conduct which could reasonably be considered inappropriate in a
28
+ professional setting
29
+
30
+ ## Enforcement Responsibilities
31
+
32
+ Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
33
+
34
+ Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
35
+
36
+ ## Scope
37
+
38
+ This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
39
+
40
+ ## Enforcement
41
+
42
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at masa@aileron.cc. All complaints will be reviewed and investigated promptly and fairly.
43
+
44
+ All community leaders are obligated to respect the privacy and security of the reporter of any incident.
45
+
46
+ ## Enforcement Guidelines
47
+
48
+ Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
49
+
50
+ ### 1. Correction
51
+
52
+ **Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
53
+
54
+ **Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
55
+
56
+ ### 2. Warning
57
+
58
+ **Community Impact**: A violation through a single incident or series of actions.
59
+
60
+ **Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
61
+
62
+ ### 3. Temporary Ban
63
+
64
+ **Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
65
+
66
+ **Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
67
+
68
+ ### 4. Permanent Ban
69
+
70
+ **Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
71
+
72
+ **Consequence**: A permanent ban from any sort of public interaction within the community.
73
+
74
+ ## Attribution
75
+
76
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
77
+ available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
78
+
79
+ Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
80
+
81
+ [homepage]: https://www.contributor-covenant.org
82
+
83
+ For answers to common questions about this code of conduct, see the FAQ at
84
+ https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2023 Masa (Aileron inc)
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,39 @@
1
+ # SfConnect
2
+
3
+ TODO: Delete this and the text below, and describe your gem
4
+
5
+ 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/sf_connect`. To experiment with that code, run `bin/console` for an interactive prompt.
6
+
7
+ ## Installation
8
+
9
+ TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
10
+
11
+ Install the gem and add to the application's Gemfile by executing:
12
+
13
+ $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
14
+
15
+ If bundler is not being used to manage dependencies, install the gem by executing:
16
+
17
+ $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
18
+
19
+ ## Usage
20
+
21
+ TODO: Write usage instructions here
22
+
23
+ ## Development
24
+
25
+ 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.
26
+
27
+ 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).
28
+
29
+ ## Contributing
30
+
31
+ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/sf_connect. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/sf_connect/blob/main/CODE_OF_CONDUCT.md).
32
+
33
+ ## License
34
+
35
+ The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
36
+
37
+ ## Code of Conduct
38
+
39
+ Everyone interacting in the SfConnect project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/sf_connect/blob/main/CODE_OF_CONDUCT.md).
data/Rakefile ADDED
@@ -0,0 +1,12 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "bundler/gem_tasks"
4
+ require "rspec/core/rake_task"
5
+
6
+ RSpec::Core::RakeTask.new(:spec)
7
+
8
+ require "rubocop/rake_task"
9
+
10
+ RuboCop::RakeTask.new
11
+
12
+ task default: %i[spec rubocop]
@@ -0,0 +1,31 @@
1
+ module SfConnect
2
+ #
3
+ # define to salesforce connective module
4
+ #
5
+ class Define
6
+ attr_reader :salesforce_object_name, :fields
7
+
8
+ def initialize(salesforce_object_name, fields:, where: nil, &block)
9
+ @salesforce_object_name = salesforce_object_name
10
+ @define = generate_binding
11
+ @define.include(SfConnect::Downloader)
12
+ @define.include(SfConnect::Uploader)
13
+ @fields = SfConnect::Fields.new(fields:, where:, salesforce_object_name:, block:)
14
+ end
15
+
16
+ def call
17
+ @define
18
+ end
19
+
20
+ def generate_binding
21
+ define = self
22
+ Module.new do
23
+ extend ActiveSupport::Concern
24
+ class_methods do
25
+ define_method(:salesforce_object_name) { define.salesforce_object_name }
26
+ define_method(:salesforce_fields) { define.fields }
27
+ end
28
+ end
29
+ end
30
+ end
31
+ end
@@ -0,0 +1,45 @@
1
+ module SfConnect
2
+ #
3
+ # download salesforce objects
4
+ #
5
+ module Downloader
6
+ extend ActiveSupport::Concern
7
+
8
+ def fetch
9
+ self.class.fetch(salesforce_object_id)
10
+ end
11
+
12
+ def download_from_salesforce
13
+ self.class.download_salesforce_record(salesforce_object_id)
14
+ end
15
+
16
+ class_methods do
17
+ def find_or_initialize_from_salesforce(binding_attributes)
18
+ find_or_initialize_by(id: binding_attributes[:id])
19
+ end
20
+
21
+ def fetch(id, field = nil)
22
+ salesforce_fields.fetch(id, field)
23
+ end
24
+
25
+ def fetch_all(query = "", &)
26
+ return enum_for(:fetch_all, query) unless block_given?
27
+
28
+ salesforce_fields.fetch_all(query, &)
29
+ end
30
+
31
+ def download_salesforce_record(salesforce_object_id)
32
+ result = fetch(salesforce_object_id)
33
+ record = find_or_initialize_from_salesforce(result.binding_attributes)
34
+ record.update(result.binding_attributes)
35
+ record
36
+ end
37
+
38
+ def download_salesforce_records(batch_size = 1000)
39
+ fetch_all.each_slice(batch_size) do |records|
40
+ upsert_all records.map(&:binding_attributes)
41
+ end
42
+ end
43
+ end
44
+ end
45
+ end
@@ -0,0 +1,65 @@
1
+ module SfConnect
2
+ #
3
+ # salesforce fields <=> object attributes
4
+ #
5
+ class Fields
6
+ attr_reader :salesforce_object_name, :query, :fields, :result_class
7
+
8
+ def initialize(salesforce_object_name:, where:, fields:, block:)
9
+ @fields = fields
10
+ @salesforce_object_name = salesforce_object_name
11
+ @query = "select #{fields.keys.join(",")} from #{salesforce_object_name}"
12
+ @query = "#{@query} where #{where}" if where
13
+
14
+ @result_class = Class.new(SfConnect::Result)
15
+ @result_class.include(Module.new(&block)) if block
16
+ end
17
+
18
+ def fetch(id, field = nil)
19
+ result(SfConnect.find(salesforce_object_name, id, field))
20
+ end
21
+
22
+ def fetch_all(query_option)
23
+ SfConnect.query(query + query_option).each do |sobject|
24
+ yield result(sobject)
25
+ end
26
+ end
27
+
28
+ def convert_to_salesforce_from_hash(target)
29
+ convert do |saeslforce_field_name, object_field_name|
30
+ [
31
+ saeslforce_field_name,
32
+ target[object_field_name]
33
+ ]
34
+ end
35
+ end
36
+
37
+ def convert_to_salesforce(target)
38
+ convert do |saeslforce_field_name, object_field_name|
39
+ [
40
+ saeslforce_field_name,
41
+ target.try(object_field_name)
42
+ ]
43
+ end
44
+ end
45
+
46
+ def convert_from_salesforce(target)
47
+ convert do |saeslforce_field_name, object_field_name|
48
+ [
49
+ object_field_name,
50
+ target.try(saeslforce_field_name)
51
+ ]
52
+ end
53
+ end
54
+
55
+ private
56
+
57
+ def result(record)
58
+ result_class.new(record:, binding_attributes: convert_from_salesforce(record))
59
+ end
60
+
61
+ def convert(&)
62
+ @fields.compact.filter_map(&).to_h
63
+ end
64
+ end
65
+ end
@@ -0,0 +1,36 @@
1
+ module SfConnect
2
+ #
3
+ # upload salesforce object attribute
4
+ #
5
+ module Uploader
6
+ extend ActiveSupport::Concern
7
+
8
+ def upload_to_salesforce
9
+ self.class.update_salesforce_attributes(salesforce_object_id, upload_payload_for_salesforce)
10
+ end
11
+
12
+ def upload_payload_for_salesforce
13
+ self.class.salesforce_fields.convert_to_salesforce(self)
14
+ end
15
+
16
+ class_methods do
17
+ def upload_salesforce_record(**attributes)
18
+ create_salesforce_record(
19
+ salesforce_fields.convert_to_salesforce_from_hash(attributes)
20
+ )
21
+ end
22
+
23
+ def create_salesforce_record(payload)
24
+ SfConnect.create!(salesforce_object_name, payload)
25
+ end
26
+
27
+ def update_salesforce_attributes(id, payload)
28
+ SfConnect.update!(
29
+ salesforce_object_name,
30
+ id,
31
+ payload
32
+ )
33
+ end
34
+ end
35
+ end
36
+ end
@@ -0,0 +1,3 @@
1
+ module SfConnect
2
+ VERSION = "0.1.1".freeze
3
+ end
data/lib/sf_connect.rb ADDED
@@ -0,0 +1,42 @@
1
+ require_relative "sf_connect/version"
2
+ require "active_support/all"
3
+
4
+ #
5
+ # salesforce connective object
6
+ #
7
+ module SfConnect
8
+ extend ActiveSupport::Autoload
9
+ autoload :Define
10
+ autoload :Fields
11
+ autoload :Uploader
12
+ autoload :Downloader
13
+
14
+ # fetch salseforce result
15
+ Result = Struct.new(:record, :binding_attributes, keyword_init: true)
16
+
17
+ class << self
18
+ def define(salesforce_object_name, where: nil, **fields, &)
19
+ SfConnect::Define.new(salesforce_object_name, where:, fields:, &).call
20
+ end
21
+
22
+ def query(soql)
23
+ Restforce.new.query(soql)
24
+ end
25
+
26
+ def find(salesforce_object_name, id, field)
27
+ Restforce.new.find(salesforce_object_name, id, field)
28
+ end
29
+
30
+ def create!(salesforce_object_name, payload)
31
+ Restforce.new.create!(
32
+ salesforce_object_name, payload
33
+ )
34
+ end
35
+
36
+ def update!(salesforce_object_name, id, payload)
37
+ Restforce.new.update!(
38
+ salesforce_object_name, { Id: id, **payload }
39
+ )
40
+ end
41
+ end
42
+ end
@@ -0,0 +1,4 @@
1
+ module SfConnect
2
+ VERSION: String
3
+ # See the writing guide of rbs: https://github.com/ruby/rbs#guides
4
+ end
metadata ADDED
@@ -0,0 +1,89 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: sf_connect
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.1
5
+ platform: ruby
6
+ authors:
7
+ - Masa (Aileron inc)
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2023-10-23 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: restforce
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ">="
18
+ - !ruby/object:Gem::Version
19
+ version: '2.0'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ">="
25
+ - !ruby/object:Gem::Version
26
+ version: '2.0'
27
+ - !ruby/object:Gem::Dependency
28
+ name: activesupport
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - ">="
32
+ - !ruby/object:Gem::Version
33
+ version: 6.0.0
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - ">="
39
+ - !ruby/object:Gem::Version
40
+ version: 6.0.0
41
+ description: A gem for integrating ActiveRecord and Salesforce using Restforce
42
+ email:
43
+ - masa@aileron.cc
44
+ executables: []
45
+ extensions: []
46
+ extra_rdoc_files: []
47
+ files:
48
+ - ".rspec"
49
+ - ".rubocop.yml"
50
+ - CHANGELOG.md
51
+ - CODE_OF_CONDUCT.md
52
+ - LICENSE.txt
53
+ - README.md
54
+ - Rakefile
55
+ - lib/sf_connect.rb
56
+ - lib/sf_connect/define.rb
57
+ - lib/sf_connect/downloader.rb
58
+ - lib/sf_connect/fields.rb
59
+ - lib/sf_connect/uploader.rb
60
+ - lib/sf_connect/version.rb
61
+ - sig/sf_connect.rbs
62
+ homepage: https://github.com/aileron-inc/sf_connect
63
+ licenses:
64
+ - MIT
65
+ metadata:
66
+ homepage_uri: https://github.com/aileron-inc/sf_connect
67
+ source_code_uri: https://github.com/aileron-inc/sf_connect
68
+ changelog_uri: https://github.com/aileron-inc/sf_connect/CHANGELOG.md
69
+ rubygems_mfa_required: 'true'
70
+ post_install_message:
71
+ rdoc_options: []
72
+ require_paths:
73
+ - lib
74
+ required_ruby_version: !ruby/object:Gem::Requirement
75
+ requirements:
76
+ - - ">="
77
+ - !ruby/object:Gem::Version
78
+ version: '3.2'
79
+ required_rubygems_version: !ruby/object:Gem::Requirement
80
+ requirements:
81
+ - - ">="
82
+ - !ruby/object:Gem::Version
83
+ version: '0'
84
+ requirements: []
85
+ rubygems_version: 3.4.20
86
+ signing_key:
87
+ specification_version: 4
88
+ summary: ActiveRecord and Salesforce integration gem
89
+ test_files: []