shopify-sinatra-app 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8eb803c14a147fef3795d5597e87493010740082
-  data.tar.gz: d859264f939678dcfa015ed39c4eec2603285900
+  metadata.gz: ebf27b104b99f8d138a0c5c3c871cdc3edd9558c
+  data.tar.gz: 107fa00dc3e77b8f8f07ab5cb21b978b22863406
 SHA512:
-  metadata.gz: 08194ed5b3a72721ec0330d067d105733c7ef4ab7e699914d0ca402cce0dff7d38446691ae61717521d914735db2ecb7c57ad7b07b39abf1affd0e3d64014dc3
-  data.tar.gz: b76b46a294aaa30621da6edd4cb0022c1d5c58307e9b87a28696ce4c07d06adf42564fa0afb015f0883ee436639de66e0f64c30d89d403ce1edfb1dd9337f04d
+  metadata.gz: c1a134962895a415bfcc25b48d8ec1da62f1d861f2fd42799627edcecb3ef96dc9875639025851a5153e2e3a1cdfcbb61010feb1bda9ce112e4fe01860325a3f
+  data.tar.gz: b52f04425dff3d76ce9e1480b5080614e910320b8a0e3e23b464344bc3ba7c48b39f2bd610be39418827478427e6ede55b844e9048ff696e733f1bb380a8bd19

data/.travis.yml

@@ -1,7 +1,7 @@
 language: ruby
 
 rvm:
-  - 2.1.5
+  - 2.3.1
 
 gemfile: example/Gemfile
 

data/CHANGELOG

@@ -1,3 +1,11 @@
+0.3.1
+-----
+* update authentication code for upcoming chrome changes.
+
+0.3.0
+-----
+* Remove sinatra-twitter-bootstrap dependency. Include css from cdn directly for example app.
+
 0.2.0
 -----
 * added a SHOPIFY_REDIRECT_URI env param for setting the redirect_uri (was breifly HOSTNAME)

data/README.md

@@ -3,7 +3,8 @@ shopify-sinatra-app [![Build Status](https://travis-ci.org/kevinhughes27/shopify
 
 "A classy shopify app"
 
-shopify-sinatra-app is lightweight extension for building Shopify apps using Sinatra. It comes with the Shopify API gem for interacting with the Shopify API and uses the Shopify omniauth gem to handle authentication. The framework itself provides a handful of helper methods to make creating your app as easy as possible. The framework was designed with deployment to Heroku in mind and following the instructions below I've been able to create a new application from scratch, deploy it to Heroku and install on my live test shop in less than 5 minutes.
+shopify-sinatra-app is lightweight extension for building Shopify apps using Sinatra. It comes with the Shopify API gem for interacting with the Shopify API and uses the Shopify omniauth gem to handle authentication via Oauth (other auth methods are not supported). The framework itself provides a handful of helper methods to make creating your app as easy as possible. The framework was designed with deployment to Heroku in mind and following the instructions below I've been able to create a new application from scratch, deploy it to Heroku and install on my live test shop in less than 5 minutes.
+
 
 Getting Started
 ---------------
@@ -66,12 +67,12 @@ After creating your new application you need to edit the `.env` file and add the
 ```
 SHOPIFY_API_KEY=<your api key>
 SHOPIFY_SHARED_SECRET=<your shared secret>
-SHOPIFY_REDIRECT_URI="<your redirect_uri>"
 SECRET=<generate a random string to encrypt credentials with>
 ```
 
 If your app has any other secret credentials you should add them to this file.
 
+
 Shopify::Methods
 ----------------
 
@@ -137,11 +138,10 @@ end
 
 note - a flash must be followed by a redirect or it won't work!
 
+
 Developing
 ----------
-You can set the application url in the [Shopify Partner area](https://app.shopify.com/services/partners/api_clients) to be `http://localhost:4567/` which will allow you to install your app on a live shop while running it locally.
-
-When developing locally you'll need to enable unsafe javascripts in your browser for the Embedded App SDK to function. Read more [here](http://docs.shopify.com/embedded-app-sdk/getting-started).
+The embedded app sdk won't load non https content so you'll need to use a forwarding service like [ngrok](https://ngrok.com/) or [forwardhq](https://forwardhq.com/). Set your application url in the [Shopify Partner area](https://app.shopify.com/services/partners/api_clients) to your forwarded url. However The redirect_uri should still be `http://localhost:4567/auth/shopify/callback` which will allow you to install your app on a live shop while running it locally.
 
 To run the app locally we use `foreman` which comes with the [Heroku Toolbelt](https://devcenter.heroku.com/articles/quickstart). Foreman handles running our application and setting our credentials as environment variables. To run the application type:
 
@@ -153,13 +153,8 @@ Note - we use `foreman run ...` not `foreman start ...` because we only want to
 
 To debug your app simply add `require 'byebug'` at the top and then type `byebug` where you would like to drop into an interactive session. You may also want to try out [Pry](http://pryrepl.org/).
 
-While running the app locally you'll be able to test the install and other routes because your browser is aware of your local application but if you want to test a route that listens to a webhook this will not work because Shopify cannot talk to your local web application. You could expose your local application to the web but an easier solution is to use a tool called [Ngrok](https://ngrok.com/). Download Ngrok and run it on port 4567 (or whichever port you  are using):
-
-```
-./ngrok 4567
-```
+If you are testing webhooks locally make sure they also go through the forwarded url and not `localhost`.
 
-Ngrok will report what address your app is available at, leave Ngrok running and then create your webhook to point to the ngrok url plus your route e.g. `<ngrok url>/webhook_test.json`. Now trigger the webhook you are testing and it will get forwarded through ngrok to your local web application allowing you to use debuggers and REPLs to complete your code.
 
 Testing
 -------
@@ -175,6 +170,7 @@ bundle exec rake test
 
 Checkout the contents of the `app_test.rb` file and the `test_helper.rb` and modify them as you add functionality to your app. You can also check the tests of other apps using this framework to see more about how to write tests for your own app.
 
+
 Deploying
 ---------
 
@@ -231,6 +227,7 @@ Note - if you are not using any background queue for processing webhooks then yo
 
 Make sure you set your shopify apps url to your Heroku app url (and make sure to use the `https` version or else the Embedded App SDK won't work) in the Shopify Partner area https://app.shopify.com/services/partners/api_clients.
 
+
 Apps using this framework
 -------------------------
 
@@ -238,6 +235,7 @@ Apps using this framework
 * [shopify-tax-receipts](https://github.com/pickle27/shopify-tax-receipts)
 * Add yours!
 
+
 Contributing
 ------------
 

data/example/Gemfile

@@ -1,7 +1,7 @@
 source 'https://rubygems.org'
-ruby "2.2.2"
+ruby '2.3.1'
 
-gem 'shopify-sinatra-app', '~> 0.2.0'
+gem 'shopify-sinatra-app', path: '../'
 gem 'sinatra-activerecord'
 gem 'rack-flash3', require: 'rack-flash'
 

data/example/Gemfile.lock

@@ -1,3 +1,17 @@
+PATH
+  remote: ../
+  specs:
+    shopify-sinatra-app (0.3.0)
+      activesupport (~> 4.1.1)
+      attr_encrypted (~> 1.3.2)
+      omniauth-shopify-oauth2 (~> 1.1.11)
+      rack-flash3 (~> 1.0.5)
+      resque (~> 1.25.2)
+      shopify_api (~> 4.0.2)
+      sinatra (~> 1.4.6)
+      sinatra-activerecord (~> 2.0.9)
+      sinatra-redis (~> 0.3.0)
+
 GEM
   remote: https://rubygems.org/
   specs:
@@ -8,10 +22,10 @@ GEM
       activemodel (= 4.1.14)
       activesupport (= 4.1.14)
       arel (~> 5.0.0)
-    activeresource (4.0.0)
+    activeresource (4.1.0)
       activemodel (~> 4.0)
       activesupport (~> 4.0)
-      rails-observers (~> 0.1.1)
+      rails-observers (~> 0.1.2)
     activesupport (4.1.14)
       i18n (~> 0.6, >= 0.6.9)
       json (~> 1.7, >= 1.7.7)
@@ -19,8 +33,8 @@ GEM
       thread_safe (~> 0.1)
       tzinfo (~> 1.1)
     arel (5.0.1.20140414130214)
-    attr_encrypted (1.3.4)
-      encryptor (>= 1.3.0)
+    attr_encrypted (1.3.5)
+      encryptor (~> 1.3.0)
     builder (3.2.2)
     byebug (8.2.1)
     dotenv (2.0.2)
@@ -30,31 +44,32 @@ GEM
       multipart-post (>= 1.2, < 3)
     foreman (0.78.0)
       thor (~> 0.19.1)
-    hashie (3.4.3)
+    hashie (3.4.6)
     i18n (0.7.0)
     json (1.8.3)
-    jwt (1.5.2)
+    jwt (1.5.1)
     metaclass (0.0.4)
     minitest (5.8.3)
     mocha (1.1.0)
       metaclass (~> 0.0.1)
     mono_logger (1.1.0)
-    multi_json (1.11.2)
-    multi_xml (0.5.5)
+    multi_json (1.12.1)
+    multi_xml (0.6.0)
     multipart-post (2.0.0)
-    oauth2 (1.0.0)
+    oauth2 (1.1.0)
       faraday (>= 0.8, < 0.10)
-      jwt (~> 1.0)
+      jwt (~> 1.0, < 1.5.2)
       multi_json (~> 1.3)
       multi_xml (~> 0.5)
-      rack (~> 1.2)
-    omniauth (1.2.2)
+      rack (>= 1.2, < 3)
+    omniauth (1.3.2)
       hashie (>= 1.2, < 4)
-      rack (~> 1.0)
+      rack (>= 1.0, < 3)
     omniauth-oauth2 (1.4.0)
       oauth2 (~> 1.0)
       omniauth (~> 1.2)
-    omniauth-shopify-oauth2 (1.1.11)
+    omniauth-shopify-oauth2 (1.1.16)
+      oauth2 (~> 1.1.0)
       omniauth-oauth2 (~> 1.2)
     pg (0.18.4)
     rack (1.6.4)
@@ -67,7 +82,7 @@ GEM
     rails-observers (0.1.2)
       activemodel (~> 4.0)
     rake (10.4.2)
-    redis (3.2.2)
+    redis (3.3.2)
     redis-namespace (1.5.2)
       redis (~> 3.0, >= 3.0.4)
     resque (1.25.2)
@@ -76,17 +91,6 @@ GEM
       redis-namespace (~> 1.3)
       sinatra (>= 0.9.2)
       vegas (~> 0.1.2)
-    shopify-sinatra-app (0.2.0)
-      activesupport (~> 4.1.1)
-      attr_encrypted (~> 1.3.2)
-      omniauth-shopify-oauth2 (~> 1.1.11)
-      rack-flash3 (~> 1.0.5)
-      resque (~> 1.25.2)
-      shopify_api (~> 4.0.2)
-      sinatra (~> 1.4.6)
-      sinatra-activerecord (~> 2.0.9)
-      sinatra-redis (~> 0.3.0)
-      sinatra-twitter-bootstrap (~> 2.3.3)
     shopify_api (4.0.7)
       activeresource
       rack
@@ -100,7 +104,6 @@ GEM
     sinatra-redis (0.3.0)
       redis
       sinatra (>= 0.9.4)
-    sinatra-twitter-bootstrap (2.3.4)
     sqlite3 (1.3.11)
     thor (0.19.1)
     thread_safe (0.3.5)
@@ -124,9 +127,12 @@ DEPENDENCIES
   rack-flash3
   rack-test
   rake
-  shopify-sinatra-app (~> 0.2.0)
+  shopify-sinatra-app!
   sinatra-activerecord
   sqlite3
 
+RUBY VERSION
+   ruby 2.3.1p112
+
 BUNDLED WITH
-   1.11.2
+   1.13.6

data/example/views/install.erb

@@ -29,9 +29,11 @@
 
   <div class="container">
     <form role="form" class="form-large" action="/login" method="post">
-        <div class="input-append">
-          <input class="form-control form-wide" type="url" name="shop" placeholder="Shop URL">
-          <input class="btn" type="submit" value="Install App" />
+        <div class="input-group form-wide">
+          <input class="form-control" type="url" name="shop" placeholder="Shop URL">
+          <span class="input-group-btn">
+            <input class="btn" type="submit" value="Install App" />
+          </span>
         </div>
     </form>
   </div>

data/lib/sinatra/shopify-sinatra-app.rb

@@ -87,9 +87,9 @@ module Sinatra
       end
 
       def authenticate(return_to = '/')
-        if shop_name = sanitize_shop_param(params)
+        if shop_name = sanitized_shop_name
           redirect_url = "/auth/shopify?shop=#{shop_name}&return_to=#{base_url}#{return_to}"
-          fullpage_redirect_to redirect_url
+          redirect_javascript redirect_url
         else
           redirect '/install'
         end
@@ -106,12 +106,38 @@ module Sinatra
         shop.save
       end
 
-      def fullpage_redirect_to(redirect_url)
-        @fullpage_redirect_to = redirect_url
+      def redirect_javascript(url)
+        erb %(
+          <!DOCTYPE html>
+          <html lang="en">
+          <head>
+            <meta charset="utf-8" />
+            <base target="_top">
+            <title>Redirecting…</title>
+
+            <script type='text/javascript'>
+              // If the current window is the 'parent', change the URL by setting location.href
+              if (window.top == window.self) {
+                window.top.location.href = #{url.to_json};
+
+              // If the current window is the 'child', change the parent's URL with postMessage
+              } else {
+                message = JSON.stringify({
+                  message: 'Shopify.API.remoteRedirect',
+                  data: { location: window.location.origin + #{url.to_json} }
+                });
+                window.parent.postMessage(message, 'https://#{sanitized_shop_name}');
+              }
+            </script>
+          </head>
+          <body>
+          </body>
+        </html>
+        %), layout: false
+      end
 
-        erb "<script type='text/javascript'>
-              window.top.location.href = '<%= @fullpage_redirect_to %>';
-            </script>", layout: false
+      def sanitized_shop_name
+        @sanitized_shop_name ||= sanitize_shop_param(params)
       end
 
       def sanitize_shop_param(params)
@@ -179,7 +205,6 @@ module Sinatra
         provider :shopify,
                  app.settings.api_key,
                  app.settings.shared_secret,
-                 redirect_uri: app.settings.redirect_uri,
 
                  scope: app.settings.scope,
 

data/shopify-sinatra-app.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'shopify-sinatra-app'
-  s.version = '0.3.0'
+  s.version = '0.3.1'
 
   s.summary     = 'A classy shopify app'
   s.description = 'A Sinatra extension for building Shopify Apps. Akin to the shopify_app gem but for Sinatra'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shopify-sinatra-app
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Kevin Hughes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-07 00:00:00.000000000 Z
+date: 2017-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -282,7 +282,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A classy shopify app