embed_me 0.1.3 → 0.1.4

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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: d6f50516697162b7dcf6b4a49f3abcf291e8610c306a2571289824beb0bd378b
4
- data.tar.gz: 6f4a52b64c264725018780c7e6d3b4c1653e8ccaa893bf3863204970893062de
3
+ metadata.gz: 8dda6ba0fa5e0b54818fad9ef0a7a66e1d5070e4c301d1adfb3bfce86be3e365
4
+ data.tar.gz: 13eefa617694cb83162141313f4c6f4e5e9975c8a5afa30c880eb7294a86abc9
5
5
  SHA512:
6
- metadata.gz: baabfddd2f40a97cad3a0b1bf3d029c56f970a5933d84fd3dd849967c9da99eaab3690375cee43aff4da5488e5a229a06c43bb691adfab9a758fe0dbd0957dad
7
- data.tar.gz: 991cb1bc03f6fc67039a158cee8156f414a2e2f0b63a3e13f7ffb5f862548debc53e189a6a34961a34ff0406cfba22c72abd207cc9d070026b8a9ce788db1e1f
6
+ metadata.gz: 6b620f0fcae3dba68a31afc00d6566a5c6ee60ed786b9c41001e17a13223ce1840b4facc3331762f32ec031d7e9f1020e6d847a5f85a50b59b76138879f4c864
7
+ data.tar.gz: 6f7eeffbfb718e2e2c44bb7e329c667697ba079f5f97ff44942bb5d6b297ca6d0b7223e294e9cb974eabe7232270264c59f968f2c559d6e87ed33e6a49ad0f1f
data/README.md CHANGED
@@ -2,22 +2,33 @@
2
2
  EmbedMe allows you and your users to easily embed your rails application or parts of it on other websites.
3
3
 
4
4
 
5
+ ## Table of Contents
6
+ - [Use Cases](#use-cases)
7
+ - [Installation](#installation)
8
+ - [Usage](#usage)
9
+ - [Define Embeddable Routes](#define-embeddable-routes)
10
+ - [Adjust Behaviour of Application](#adjust-behaviour-of-application)
11
+ - [Provide Embed-Code](#provide-embed-code)
12
+ - [Adjust Links on embeddable Pages](#adjust-links-on-embeddable-pages)
13
+ - [License](#license)
14
+
15
+
5
16
  ## Use Cases
6
17
 
7
18
  ### YouTube
8
19
  YouTube has offered this feature for years. Users have the option to embed a video from YouTube on their own blog or website. While normal YouTube content (www.youtube.com/watch?v=) is blocked by the X-Frame options, content via a YouTube Embed URL (www.youtube.com/embed/...) can be displayed in a frame. If a video is opened in a frame, the appearance is optimized so that it works well in a frame (no ratings, no comments, only video). Although YouTube does not use this gem for this function, the way this gem works is adapted accordingly.
9
20
 
10
- ![EmbedMe example use case (YouTube) for embedding in rails](images/embed_me-example-use-case-youtube-1.png)
21
+ ![EmbedMe example use case (YouTube) for embedding in rails](https://raw.github.com/tobiasbhn/embed-me/master/images/embed_me-example-use-case-youtube-1.png)
11
22
 
12
- ![EmbedMe example use case (YouTube) for embedding in rails](images/embed_me-example-use-case-youtube-2.png)
23
+ ![EmbedMe example use case (YouTube) for embedding in rails](https://raw.github.com/tobiasbhn/embed-me/master/images/embed_me-example-use-case-youtube-2.png)
13
24
 
14
25
 
15
26
  ### Other Examples
16
27
  Similar functions are also available on Twitter, Instagram, Google Maps and many other sites.
17
28
 
18
- ![EmbedMe example use case (Instagram) for embedding in rails](images/embed_me-example-use-case-instagram.png)
29
+ ![EmbedMe example use case (Instagram) for embedding in rails](https://raw.github.com/tobiasbhn/embed-me/master/images/embed_me-example-use-case-instagram.png)
19
30
 
20
- ![EmbedMe example use case (Twitter) for embedding in rails](images/embed_me-example-use-case-twitter.png)
31
+ ![EmbedMe example use case (Twitter) for embedding in rails](https://raw.github.com/tobiasbhn/embed-me/master/images/embed_me-example-use-case-twitter.png)
21
32
 
22
33
 
23
34
  ## Installation
@@ -89,7 +100,7 @@ You may want to show the user of your application the code to include the resour
89
100
 
90
101
  To get the default interface, use the function `embed_frontend`, which returns an HTML button to open a basic pop-up that allows the user of the web page to copy the embedding code. The default design can be overridden with a file at `app/views/embed_me/_embed_frontend.html.erb`.
91
102
 
92
- ```html
103
+ ```
93
104
  <div class="container-fluid d-flex align-items-center">
94
105
  <!-- some frontend stuff -->
95
106
  <%= embed_frontend %>
@@ -98,7 +109,7 @@ To get the default interface, use the function `embed_frontend`, which returns a
98
109
 
99
110
  Default Popup will look like this:
100
111
 
101
- ![EmbedMe default popup to embed rails resource](images/embed_me-default-popup.png)
112
+ ![EmbedMe default popup to embed rails resource](https://raw.github.com/tobiasbhn/embed-me/master/images/embed_me-default-popup.png)
102
113
 
103
114
  #### Default Embedding Code
104
115
 
@@ -146,7 +157,7 @@ embeddable_link_to("Embeddable", embeddable_path)
146
157
  # => <a href="/embed/embeddable">Embeddable</a>
147
158
  ```
148
159
 
149
- #### Embedded Link Available?
160
+ #### Embedded Link Available
150
161
 
151
162
  Checks whether there is an embedded version of a specific route.
152
163
 
@@ -1,3 +1,3 @@
1
1
  module EmbedMe
2
- VERSION = '0.1.3'
2
+ VERSION = '0.1.4'
3
3
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: embed_me
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.3
4
+ version: 0.1.4
5
5
  platform: ruby
6
6
  authors:
7
7
  - Tobias Bohn
@@ -57,11 +57,6 @@ files:
57
57
  - Rakefile
58
58
  - app/assets/config/embed_me_manifest.js
59
59
  - app/assets/stylesheets/embed_me/application.css
60
- - app/controllers/embed_me/application_controller.rb
61
- - app/helpers/embed_me/application_helper.rb
62
- - app/jobs/embed_me/application_job.rb
63
- - app/mailers/embed_me/application_mailer.rb
64
- - app/models/embed_me/application_record.rb
65
60
  - app/views/embed_me/_embed_frontend.html.erb
66
61
  - app/views/layouts/embed_me/application.html.erb
67
62
  - config/routes.rb
@@ -1,5 +0,0 @@
1
- module EmbedMe # :nodoc: all
2
- class ApplicationController < ActionController::Base
3
- protect_from_forgery with: :exception
4
- end
5
- end
@@ -1,4 +0,0 @@
1
- module EmbedMe # :nodoc: all
2
- module ApplicationHelper
3
- end
4
- end
@@ -1,4 +0,0 @@
1
- module EmbedMe # :nodoc: all
2
- class ApplicationJob < ActiveJob::Base
3
- end
4
- end
@@ -1,6 +0,0 @@
1
- module EmbedMe # :nodoc: all
2
- class ApplicationMailer < ActionMailer::Base
3
- default from: 'from@example.com'
4
- layout 'mailer'
5
- end
6
- end
@@ -1,5 +0,0 @@
1
- module EmbedMe # :nodoc: all
2
- class ApplicationRecord < ActiveRecord::Base
3
- self.abstract_class = true
4
- end
5
- end