spiffy_stores_app 8.2.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (68) hide show
  1. checksums.yaml +7 -0
  2. data/.gitignore +13 -0
  3. data/.rubocop.yml +7 -0
  4. data/.travis.yml +9 -0
  5. data/CHANGELOG.md +3 -0
  6. data/Gemfile +6 -0
  7. data/README.md +346 -0
  8. data/Rakefile +6 -0
  9. data/app/assets/javascripts/spiffy_stores_app/redirect.js +19 -0
  10. data/app/controllers/spiffy_stores_app/authenticated_controller.rb +11 -0
  11. data/app/controllers/spiffy_stores_app/sessions_controller.rb +113 -0
  12. data/app/controllers/spiffy_stores_app/webhooks_controller.rb +36 -0
  13. data/app/views/spiffy_stores_app/sessions/new.html.erb +123 -0
  14. data/app/views/spiffy_stores_app/shared/redirect.html.erb +22 -0
  15. data/config/locales/de.yml +3 -0
  16. data/config/locales/en.yml +4 -0
  17. data/config/locales/es.yml +3 -0
  18. data/config/locales/fr.yml +4 -0
  19. data/config/locales/ja.yml +3 -0
  20. data/config/routes.rb +12 -0
  21. data/docs/Quickstart.md +76 -0
  22. data/images/app-proxy-screenshot.png +0 -0
  23. data/lib/generators/spiffy_stores_app/add_after_authenticate_job/add_after_authenticate_job_generator.rb +43 -0
  24. data/lib/generators/spiffy_stores_app/add_after_authenticate_job/templates/after_authenticate_job.rb +10 -0
  25. data/lib/generators/spiffy_stores_app/add_webhook/add_webhook_generator.rb +68 -0
  26. data/lib/generators/spiffy_stores_app/add_webhook/templates/webhook_job.rb +8 -0
  27. data/lib/generators/spiffy_stores_app/app_proxy_controller/app_proxy_controller_generator.rb +25 -0
  28. data/lib/generators/spiffy_stores_app/app_proxy_controller/templates/app_proxy_controller.rb +8 -0
  29. data/lib/generators/spiffy_stores_app/app_proxy_controller/templates/app_proxy_route.rb +10 -0
  30. data/lib/generators/spiffy_stores_app/app_proxy_controller/templates/index.html.erb +19 -0
  31. data/lib/generators/spiffy_stores_app/controllers/controllers_generator.rb +29 -0
  32. data/lib/generators/spiffy_stores_app/home_controller/home_controller_generator.rb +31 -0
  33. data/lib/generators/spiffy_stores_app/home_controller/templates/home_controller.rb +6 -0
  34. data/lib/generators/spiffy_stores_app/home_controller/templates/index.html.erb +21 -0
  35. data/lib/generators/spiffy_stores_app/home_controller/templates/spiffy_stores_app_ready_script.html.erb +7 -0
  36. data/lib/generators/spiffy_stores_app/install/install_generator.rb +58 -0
  37. data/lib/generators/spiffy_stores_app/install/templates/_flash_messages.html.erb +19 -0
  38. data/lib/generators/spiffy_stores_app/install/templates/embedded_app.html.erb +40 -0
  39. data/lib/generators/spiffy_stores_app/install/templates/omniauth.rb +2 -0
  40. data/lib/generators/spiffy_stores_app/install/templates/spiffy_provider.rb +11 -0
  41. data/lib/generators/spiffy_stores_app/install/templates/spiffy_stores_app.rb +9 -0
  42. data/lib/generators/spiffy_stores_app/routes/routes_generator.rb +31 -0
  43. data/lib/generators/spiffy_stores_app/routes/templates/routes.rb +11 -0
  44. data/lib/generators/spiffy_stores_app/shop_model/shop_model_generator.rb +38 -0
  45. data/lib/generators/spiffy_stores_app/shop_model/templates/db/migrate/create_shops.erb +15 -0
  46. data/lib/generators/spiffy_stores_app/shop_model/templates/shop.rb +3 -0
  47. data/lib/generators/spiffy_stores_app/shop_model/templates/shops.yml +3 -0
  48. data/lib/generators/spiffy_stores_app/spiffy_stores_app_generator.rb +16 -0
  49. data/lib/generators/spiffy_stores_app/views/views_generator.rb +29 -0
  50. data/lib/spiffy_stores_app.rb +34 -0
  51. data/lib/spiffy_stores_app/configuration.rb +72 -0
  52. data/lib/spiffy_stores_app/controller_concerns/app_proxy_verification.rb +38 -0
  53. data/lib/spiffy_stores_app/controller_concerns/embedded_app.rb +19 -0
  54. data/lib/spiffy_stores_app/controller_concerns/localization.rb +22 -0
  55. data/lib/spiffy_stores_app/controller_concerns/login_protection.rb +103 -0
  56. data/lib/spiffy_stores_app/controller_concerns/webhook_verification.rb +34 -0
  57. data/lib/spiffy_stores_app/engine.rb +10 -0
  58. data/lib/spiffy_stores_app/jobs/scripttags_manager_job.rb +15 -0
  59. data/lib/spiffy_stores_app/jobs/webhooks_manager_job.rb +15 -0
  60. data/lib/spiffy_stores_app/managers/scripttags_manager.rb +77 -0
  61. data/lib/spiffy_stores_app/managers/webhooks_manager.rb +61 -0
  62. data/lib/spiffy_stores_app/session/in_memory_session_store.rb +27 -0
  63. data/lib/spiffy_stores_app/session/session_repository.rb +34 -0
  64. data/lib/spiffy_stores_app/session/session_storage.rb +32 -0
  65. data/lib/spiffy_stores_app/utils.rb +16 -0
  66. data/lib/spiffy_stores_app/version.rb +3 -0
  67. data/spiffy_stores_app.gemspec +26 -0
  68. metadata +220 -0
@@ -0,0 +1,61 @@
1
+ module SpiffyStoresApp
2
+ class WebhooksManager
3
+ class CreationFailed < StandardError; end
4
+
5
+ def self.queue(shop_domain, shop_token, webhooks)
6
+ SpiffyStoresApp::WebhooksManagerJob.perform_later(
7
+ shop_domain: shop_domain,
8
+ shop_token: shop_token,
9
+ webhooks: webhooks
10
+ )
11
+ end
12
+
13
+ attr_reader :required_webhooks
14
+
15
+ def initialize(webhooks)
16
+ @required_webhooks = webhooks
17
+ end
18
+
19
+ def recreate_webhooks!
20
+ destroy_webhooks
21
+ create_webhooks
22
+ end
23
+
24
+ def create_webhooks
25
+ return unless required_webhooks.present?
26
+
27
+ required_webhooks.each do |webhook|
28
+ create_webhook(webhook) unless webhook_exists?(webhook[:topic])
29
+ end
30
+ end
31
+
32
+ def destroy_webhooks
33
+ SpiffyStoresAPI::Webhook.all.to_a.each do |webhook|
34
+ SpiffyStoresAPI::Webhook.delete(webhook.id) if is_required_webhook?(webhook)
35
+ end
36
+
37
+ @current_webhooks = nil
38
+ end
39
+
40
+ private
41
+
42
+ def is_required_webhook?(webhook)
43
+ required_webhooks.map{ |w| w[:address] }.include? webhook.address
44
+ end
45
+
46
+ def create_webhook(attributes)
47
+ attributes.reverse_merge!(format: 'json')
48
+ webhook = SpiffyStoresAPI::Webhook.create(attributes)
49
+ raise CreationFailed, webhook.errors.full_messages.to_sentence unless webhook.persisted?
50
+ webhook
51
+ end
52
+
53
+ def webhook_exists?(topic)
54
+ current_webhooks[topic]
55
+ end
56
+
57
+ def current_webhooks
58
+ @current_webhooks ||= SpiffyStoresAPI::Webhook.all.index_by(&:topic)
59
+ end
60
+ end
61
+ end
@@ -0,0 +1,27 @@
1
+ module SpiffyStoresApp
2
+ class InMemorySessionStore
3
+ class EnvironmentError < StandardError; end
4
+
5
+ def self.retrieve(id)
6
+ repo[id]
7
+ end
8
+
9
+ def self.store(session)
10
+ id = SecureRandom.uuid
11
+ repo[id] = session
12
+ id
13
+ end
14
+
15
+ def self.clear
16
+ @@repo = nil
17
+ end
18
+
19
+ def self.repo
20
+ if Rails.env.production?
21
+ raise EnvironmentError.new("Cannot use InMemorySessionStore in a Production environment. \
22
+ Please initialize SpiffyStoresApp with a model that can store and retrieve sessions")
23
+ end
24
+ @@repo ||= {}
25
+ end
26
+ end
27
+ end
@@ -0,0 +1,34 @@
1
+ module SpiffyStoresApp
2
+ class SessionRepository
3
+ class ConfigurationError < StandardError; end
4
+
5
+ class << self
6
+ def storage=(storage)
7
+ @storage = storage
8
+
9
+ unless storage.nil? || self.storage.respond_to?(:store) && self.storage.respond_to?(:retrieve)
10
+ raise ArgumentError, "storage must respond to :store and :retrieve"
11
+ end
12
+ end
13
+
14
+ def retrieve(id)
15
+ storage.retrieve(id)
16
+ end
17
+
18
+ def store(session)
19
+ storage.store(session)
20
+ end
21
+
22
+ def storage
23
+ load_storage || raise(ConfigurationError.new("SpiffyStoresSessionRepository.storage is not configured!"))
24
+ end
25
+
26
+ private
27
+
28
+ def load_storage
29
+ return unless @storage
30
+ @storage.respond_to?(:safe_constantize) ? @storage.safe_constantize : @storage
31
+ end
32
+ end
33
+ end
34
+ end
@@ -0,0 +1,32 @@
1
+ module SpiffyStoresApp
2
+ module SessionStorage
3
+ extend ActiveSupport::Concern
4
+
5
+ included do
6
+ validates :spiffy_stores_domain, presence: true, uniqueness: true
7
+ validates :spiffy_stores_token, presence: true
8
+ end
9
+
10
+ def with_spiffy_stores_session(&block)
11
+ SpiffyStoresAPI::Session.temp(spiffy_stores_domain, spiffy_stores_token, &block)
12
+ end
13
+
14
+ class_methods do
15
+ def store(session)
16
+ shop = self.find_or_initialize_by(spiffy_stores_domain: session.url)
17
+ shop.spiffy_stores_token = session.token
18
+ shop.save!
19
+ shop.id
20
+ end
21
+
22
+ def retrieve(id)
23
+ return unless id
24
+
25
+ if shop = self.find_by(id: id)
26
+ SpiffyStoresAPI::Session.new(shop.spiffy_stores_domain, shop.spiffy_stores_token, shop)
27
+ end
28
+ end
29
+ end
30
+
31
+ end
32
+ end
@@ -0,0 +1,16 @@
1
+ module SpiffyStoresApp
2
+ module Utils
3
+
4
+ def self.sanitize_shop_domain(shop_domain)
5
+ name = shop_domain.to_s.strip
6
+ name += ".#{SpiffyStoresApp.configuration.spiffy_stores_domain}" if !name.include?("#{SpiffyStoresApp.configuration.spiffy_stores_domain}") && !name.include?(".")
7
+ name.sub!(%r|https?://|, '')
8
+
9
+ u = URI("http://#{name}")
10
+ u.host if u.host&.match(/^[a-z0-9][a-z0-9\-]*[a-z0-9]\.#{Regexp.escape(SpiffyStoresApp.configuration.spiffy_stores_domain)}$/)
11
+ rescue URI::InvalidURIError
12
+ nil
13
+ end
14
+
15
+ end
16
+ end
@@ -0,0 +1,3 @@
1
+ module SpiffyStoresApp
2
+ VERSION = '8.2.6'.freeze
3
+ end
@@ -0,0 +1,26 @@
1
+ $LOAD_PATH.push File.expand_path('../lib', __FILE__)
2
+ require "spiffy_stores_app/version"
3
+
4
+ Gem::Specification.new do |s|
5
+ s.name = "spiffy_stores_app"
6
+ s.version = SpiffyStoresApp::VERSION
7
+ s.platform = Gem::Platform::RUBY
8
+ s.author = "Spiffy Stores"
9
+ s.summary = %q{This gem is used to get quickly started with the Spiffy Stores API}
10
+
11
+ s.required_ruby_version = ">= 2.3.1"
12
+
13
+ s.add_runtime_dependency('rails', '>= 5.0.0')
14
+ s.add_runtime_dependency('spiffy_stores_api', '~> 4.11.0')
15
+ s.add_runtime_dependency('omniauth-spiffy-oauth2', '~> 1.2.0')
16
+
17
+ s.add_development_dependency('rake')
18
+ s.add_development_dependency('byebug')
19
+ s.add_development_dependency('sqlite3')
20
+ s.add_development_dependency('minitest')
21
+ s.add_development_dependency('mocha')
22
+
23
+ s.files = `git ls-files`.split("\n").reject { |f| f.match(%r{^(test|example)/}) }
24
+ s.test_files = `git ls-files -- {test}/*`.split("\n")
25
+ s.require_paths = ["lib"]
26
+ end
metadata ADDED
@@ -0,0 +1,220 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: spiffy_stores_app
3
+ version: !ruby/object:Gem::Version
4
+ version: 8.2.6
5
+ platform: ruby
6
+ authors:
7
+ - Spiffy Stores
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2018-07-06 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: rails
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ">="
18
+ - !ruby/object:Gem::Version
19
+ version: 5.0.0
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ">="
25
+ - !ruby/object:Gem::Version
26
+ version: 5.0.0
27
+ - !ruby/object:Gem::Dependency
28
+ name: spiffy_stores_api
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: 4.11.0
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: 4.11.0
41
+ - !ruby/object:Gem::Dependency
42
+ name: omniauth-spiffy-oauth2
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: 1.2.0
48
+ type: :runtime
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: 1.2.0
55
+ - !ruby/object:Gem::Dependency
56
+ name: rake
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - ">="
60
+ - !ruby/object:Gem::Version
61
+ version: '0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - ">="
67
+ - !ruby/object:Gem::Version
68
+ version: '0'
69
+ - !ruby/object:Gem::Dependency
70
+ name: byebug
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - ">="
74
+ - !ruby/object:Gem::Version
75
+ version: '0'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - ">="
81
+ - !ruby/object:Gem::Version
82
+ version: '0'
83
+ - !ruby/object:Gem::Dependency
84
+ name: sqlite3
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - ">="
88
+ - !ruby/object:Gem::Version
89
+ version: '0'
90
+ type: :development
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - ">="
95
+ - !ruby/object:Gem::Version
96
+ version: '0'
97
+ - !ruby/object:Gem::Dependency
98
+ name: minitest
99
+ requirement: !ruby/object:Gem::Requirement
100
+ requirements:
101
+ - - ">="
102
+ - !ruby/object:Gem::Version
103
+ version: '0'
104
+ type: :development
105
+ prerelease: false
106
+ version_requirements: !ruby/object:Gem::Requirement
107
+ requirements:
108
+ - - ">="
109
+ - !ruby/object:Gem::Version
110
+ version: '0'
111
+ - !ruby/object:Gem::Dependency
112
+ name: mocha
113
+ requirement: !ruby/object:Gem::Requirement
114
+ requirements:
115
+ - - ">="
116
+ - !ruby/object:Gem::Version
117
+ version: '0'
118
+ type: :development
119
+ prerelease: false
120
+ version_requirements: !ruby/object:Gem::Requirement
121
+ requirements:
122
+ - - ">="
123
+ - !ruby/object:Gem::Version
124
+ version: '0'
125
+ description:
126
+ email:
127
+ executables: []
128
+ extensions: []
129
+ extra_rdoc_files: []
130
+ files:
131
+ - ".gitignore"
132
+ - ".rubocop.yml"
133
+ - ".travis.yml"
134
+ - CHANGELOG.md
135
+ - Gemfile
136
+ - README.md
137
+ - Rakefile
138
+ - app/assets/javascripts/spiffy_stores_app/redirect.js
139
+ - app/controllers/spiffy_stores_app/authenticated_controller.rb
140
+ - app/controllers/spiffy_stores_app/sessions_controller.rb
141
+ - app/controllers/spiffy_stores_app/webhooks_controller.rb
142
+ - app/views/spiffy_stores_app/sessions/new.html.erb
143
+ - app/views/spiffy_stores_app/shared/redirect.html.erb
144
+ - config/locales/de.yml
145
+ - config/locales/en.yml
146
+ - config/locales/es.yml
147
+ - config/locales/fr.yml
148
+ - config/locales/ja.yml
149
+ - config/routes.rb
150
+ - docs/Quickstart.md
151
+ - images/app-proxy-screenshot.png
152
+ - lib/generators/spiffy_stores_app/add_after_authenticate_job/add_after_authenticate_job_generator.rb
153
+ - lib/generators/spiffy_stores_app/add_after_authenticate_job/templates/after_authenticate_job.rb
154
+ - lib/generators/spiffy_stores_app/add_webhook/add_webhook_generator.rb
155
+ - lib/generators/spiffy_stores_app/add_webhook/templates/webhook_job.rb
156
+ - lib/generators/spiffy_stores_app/app_proxy_controller/app_proxy_controller_generator.rb
157
+ - lib/generators/spiffy_stores_app/app_proxy_controller/templates/app_proxy_controller.rb
158
+ - lib/generators/spiffy_stores_app/app_proxy_controller/templates/app_proxy_route.rb
159
+ - lib/generators/spiffy_stores_app/app_proxy_controller/templates/index.html.erb
160
+ - lib/generators/spiffy_stores_app/controllers/controllers_generator.rb
161
+ - lib/generators/spiffy_stores_app/home_controller/home_controller_generator.rb
162
+ - lib/generators/spiffy_stores_app/home_controller/templates/home_controller.rb
163
+ - lib/generators/spiffy_stores_app/home_controller/templates/index.html.erb
164
+ - lib/generators/spiffy_stores_app/home_controller/templates/spiffy_stores_app_ready_script.html.erb
165
+ - lib/generators/spiffy_stores_app/install/install_generator.rb
166
+ - lib/generators/spiffy_stores_app/install/templates/_flash_messages.html.erb
167
+ - lib/generators/spiffy_stores_app/install/templates/embedded_app.html.erb
168
+ - lib/generators/spiffy_stores_app/install/templates/omniauth.rb
169
+ - lib/generators/spiffy_stores_app/install/templates/spiffy_provider.rb
170
+ - lib/generators/spiffy_stores_app/install/templates/spiffy_stores_app.rb
171
+ - lib/generators/spiffy_stores_app/routes/routes_generator.rb
172
+ - lib/generators/spiffy_stores_app/routes/templates/routes.rb
173
+ - lib/generators/spiffy_stores_app/shop_model/shop_model_generator.rb
174
+ - lib/generators/spiffy_stores_app/shop_model/templates/db/migrate/create_shops.erb
175
+ - lib/generators/spiffy_stores_app/shop_model/templates/shop.rb
176
+ - lib/generators/spiffy_stores_app/shop_model/templates/shops.yml
177
+ - lib/generators/spiffy_stores_app/spiffy_stores_app_generator.rb
178
+ - lib/generators/spiffy_stores_app/views/views_generator.rb
179
+ - lib/spiffy_stores_app.rb
180
+ - lib/spiffy_stores_app/configuration.rb
181
+ - lib/spiffy_stores_app/controller_concerns/app_proxy_verification.rb
182
+ - lib/spiffy_stores_app/controller_concerns/embedded_app.rb
183
+ - lib/spiffy_stores_app/controller_concerns/localization.rb
184
+ - lib/spiffy_stores_app/controller_concerns/login_protection.rb
185
+ - lib/spiffy_stores_app/controller_concerns/webhook_verification.rb
186
+ - lib/spiffy_stores_app/engine.rb
187
+ - lib/spiffy_stores_app/jobs/scripttags_manager_job.rb
188
+ - lib/spiffy_stores_app/jobs/webhooks_manager_job.rb
189
+ - lib/spiffy_stores_app/managers/scripttags_manager.rb
190
+ - lib/spiffy_stores_app/managers/webhooks_manager.rb
191
+ - lib/spiffy_stores_app/session/in_memory_session_store.rb
192
+ - lib/spiffy_stores_app/session/session_repository.rb
193
+ - lib/spiffy_stores_app/session/session_storage.rb
194
+ - lib/spiffy_stores_app/utils.rb
195
+ - lib/spiffy_stores_app/version.rb
196
+ - spiffy_stores_app.gemspec
197
+ homepage:
198
+ licenses: []
199
+ metadata: {}
200
+ post_install_message:
201
+ rdoc_options: []
202
+ require_paths:
203
+ - lib
204
+ required_ruby_version: !ruby/object:Gem::Requirement
205
+ requirements:
206
+ - - ">="
207
+ - !ruby/object:Gem::Version
208
+ version: 2.3.1
209
+ required_rubygems_version: !ruby/object:Gem::Requirement
210
+ requirements:
211
+ - - ">="
212
+ - !ruby/object:Gem::Version
213
+ version: '0'
214
+ requirements: []
215
+ rubyforge_project:
216
+ rubygems_version: 2.7.7
217
+ signing_key:
218
+ specification_version: 4
219
+ summary: This gem is used to get quickly started with the Spiffy Stores API
220
+ test_files: []