m2fm-automatic-embed 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aaf87e4c1a4c933967340bdc50e26ae32870c421
-  data.tar.gz: 7c691c2bc155c4998b79ff901867d32ad4d5a2e2
+  metadata.gz: 6cbb12b3b9f135f055eea4e0e71885aee15a0eee
+  data.tar.gz: 57a5fccf339221992a1a7b19a0c93f3c69d9f495
 SHA512:
-  metadata.gz: e432c799da46aea2c9e753647d0420ff19a9913abd40149af34f9aac7c0dc775466f3467b7cb8822626305a6e7880578d481af7f386e2bbdada2c5c8f81a6961
-  data.tar.gz: 47744656485bed1600d4cf5f3e1953bade0dc23accd7a150b82d3f23f279d83610901a722bd4d97c62ea4f37ce2ec3b7f98bb9f041c8c5eb52ab9fcc0deff9a0
+  metadata.gz: 09cf9b98a8ab8c614ef38500573aafde4ad085fa91e139840cb02f7740f37e559738953bbe8723bb2621ef602d6c8bff8718ec7e363eb734a8a4132ddc4a1e63
+  data.tar.gz: 685f7de7543f775743520123c5b33d1788c4b501c90b053af83cbb749ddffbfce1673fbffc44a2e676cb7e642cc009447da7345c9b1c1ca5e9d7834321e1ca2d

data/README.md

@@ -19,19 +19,24 @@ And then execute:
 In your Mail2FrontMatter YAML configuration enable the plugin by adding it to your preprocessors:
 
 ```yaml
-protocol: imap
-receiver: yourblogemail@yourdomain.com
-senders:  yourpersonal@yourdomain.com
-
 preprocessors:
   - key: 'automatic-embed'
+```
+
+You can provide a whitelist or blacklist for filters as well as providing filters options. Filter options are documented at the auto_html project.
 
-mailman:
-  server: imap.gmail.com
-  port: 993
-  ssl: true
-  username: yourblogemail@yourdomain.com
-  password: yourpassword
+```yaml
+preprocessors:
+  - key: 'automatic-embed'
+    options:
+      white_list:
+        - youtube
+        - soundcloud
+        - vimeo
+      filters:
+        youtube:
+          autoplay: true
+          other_attribute: other_value
 ```
 
 ## Usage

data/fixtures/config.yml

@@ -0,0 +1,25 @@
+keys_demo:
+  white_list:
+    - youtube
+    - soundcloud
+    - vimeo
+
+white_list_demo:
+  white_list:
+    - youtube
+    - soundcloud
+    - vimeo
+
+black_list_demo:
+  black_list:
+    - vimeo
+
+options_demo:
+  white_list:
+    - youtube
+    - soundcloud
+    - vimeo
+  filters:
+    youtube:
+      autoplay: true
+

data/lib/mail2frontmatter/automatic-embeds.rb

@@ -8,18 +8,23 @@ module Mail2FrontMatter
 
     @all_filters = [:youtube, :soundcloud, :link, :ted, :twitter, :vimeo, :google_map, :gist, :flickr]
 
-    def self.run(metadata, body)
-      # I *could* introspect on auto_html here but I haven't vetted them all yet
+    def self.register(options = {})
+      super
 
+      # I *could* introspect on auto_html here but I haven't vetted them all yet
       if @options[:white_list]
-        filters = @options[:white_list]
+        @filters = @options[:white_list].map(&:to_sym)
       elsif @options[:black_list]
-        filters = @all_filters - @options[:black_list]
+        @filters = @all_filters - @options[:black_list].map(&:to_sym)
       else
-        filters = @all_filters
+        @filters = @all_filters
       end
 
-      body = auto_html(body, { filters: filters, options: @options[:filters] }) { 
+    end
+
+    def self.run(metadata, body)
+
+      body = auto_html(body, { filters: @filters, options: @options[:filters] }) { 
         # use options passed to us...
         @options[:filters].each do |filter|
           options_for_filter = @options[:options] ? (@options[:options][filter.to_sym] || {}) : {}

data/m2fm-automatic-embeds.gemspec

@@ -4,12 +4,12 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'm2fm-automatic-embed'
-  spec.version       = '0.0.1'
+  spec.version       = '0.0.2'
   spec.authors       = ['Kunal Shah']
   spec.email         = ['me@kunalashah.com']
   spec.summary       = %q{mail2frontmatter plugin to transform links into embed code automatically}
   spec.description   = spec.summary
-  spec.homepage      = 'https://github.com/whistlerbrk/m2fm-automatic-embed'
+  spec.homepage      = 'https://github.com/whistlerbrk/m2fm-automatic-embeds'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'mail2frontmatter', '>= 0.0.4'
+  spec.add_dependency 'mail2frontmatter', '>= 0.0.5'
   spec.add_dependency 'auto_html-whistlerbrk', '2.0.0.pre'
 
   spec.add_development_dependency 'byebug'

data/spec/automatic_embed_spec.rb

@@ -12,6 +12,10 @@ describe Mail2FrontMatter::Parser, "parsing" do
   let(:control) { 
     Mail::Message.new(File.read(File.join(File.dirname(__FILE__), '..', 'fixtures', 'no-links.eml'))) 
   }
+  let(:config) { 
+    test_config = File.join(File.dirname(__FILE__), '..', 'fixtures', 'config.yml')
+    config = YAML.load_file(test_config).deep_symbolize_keys!
+  }
 
   it "should identify and transform youtube link" do
     Mail2FrontMatter::AutomaticEmbed.register
@@ -23,4 +27,42 @@ describe Mail2FrontMatter::Parser, "parsing" do
 
   end
 
+  it "should store filters internally as symbols" do
+    Mail2FrontMatter::AutomaticEmbed.register(config[:keys_demo])
+    keys = Mail2FrontMatter::AutomaticEmbed.instance_variable_get :@filters
+
+    keys.all?{|k|k.is_a?(Symbol)}.should eq(true)
+  end
+
+  it "should allow a white list" do
+    Mail2FrontMatter::AutomaticEmbed.register(config[:white_list_demo])
+    keys = Mail2FrontMatter::AutomaticEmbed.instance_variable_get :@filters
+
+    white_list = [:youtube, :soundcloud, :vimeo]
+    keys.sort.should eq(white_list.sort)
+  end
+
+  it "should allow a black list" do
+    Mail2FrontMatter::AutomaticEmbed.register(config[:black_list_demo])
+    keys = Mail2FrontMatter::AutomaticEmbed.instance_variable_get :@filters
+    all_keys = Mail2FrontMatter::AutomaticEmbed.instance_variable_get :@all_filters
+
+    black_list = [:vimeo]
+    keys.sort.should eq((all_keys - black_list).sort)
+  end
+
+  it "should allow the forwarding of options to an auto_html filter" do
+    Mail2FrontMatter::AutomaticEmbed.register(config[:options_demo])
+
+    metadata = {
+      subject: "Interstellar"
+    }
+    body = "I think B Colony made the wormhole. https://www.youtube.com/watch?v=jo5m5GXF9Ec"
+
+    AutoHtml::Builder.any_instance.should_receive(:youtube).with({autoplay: true})
+
+    # run it
+    Mail2FrontMatter::AutomaticEmbed.run(metadata, body)
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: m2fm-automatic-embed
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Kunal Shah
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.4
+        version: 0.0.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.4
+        version: 0.0.5
 - !ruby/object:Gem::Dependency
   name: auto_html-whistlerbrk
   requirement: !ruby/object:Gem::Requirement
@@ -106,6 +106,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- fixtures/config.yml
 - fixtures/no-links.eml
 - fixtures/soundcloud-link.eml
 - fixtures/youtube-link.eml
@@ -113,7 +114,7 @@ files:
 - m2fm-automatic-embeds.gemspec
 - spec/automatic_embed_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/whistlerbrk/m2fm-automatic-embed
+homepage: https://github.com/whistlerbrk/m2fm-automatic-embeds
 licenses:
 - MIT
 metadata: {}