rssendy 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 52603befc01bbf23eb601acca00df56fedea0c22
+  data.tar.gz: 9cec5aef5133042e83ed91e1ec85267b2bd6a4cf
+SHA512:
+  metadata.gz: b19456cc07b88566b237b558c03d673b9b6bd8a24c006d5eeea5f5a2cb4326e9579e1f2a57d5c78df1a9191154278e0afdcd3460456cc534842eebe91633ac07
+  data.tar.gz: 404acc03610ef9ec3110e03f1e2d24629fb8d7ee4a8858048df249db2143842cf1dd2fcff72db7d1418b3f360a191ea8bea41613928ea4d28dedd894d585b5d3

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rssendy.gemspec
+gemspec
+
+gem 'cindy', git: 'https://github.com/jonuts/cindy'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 jonah honeyman
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,52 @@
+# Rssendy
+
+Hook into an RSS feed and import the results into your [sendy](http://sendy.co) installation.
+
+## Installation
+
+`rssendy` can be used either as a command line application or a library in your application.
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rssendy'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rssendy
+
+## Usage
+
+Either define a configuration file for your feed or use the CLI options. The options are as follows:
+
+| Option        | Description                                                                             | Required? |
+| ------        | -----------                                                                             | --------- |
+| config        | Path to YAML config file                                                                | *no*      |
+| api_key       | Sendy API key                                                                           | *yes*     |
+| url           | URL of sendy app                                                                        | *yes*     |
+| content       | Nokogiri parser for RSS items. This will be `eval`'d in the context of your parsed feed | *yes*     |
+| path          | Path to your feeds template file                                                        | *yes*     |
+| from-name     | The name in the 'From' field                                                            | *yes*     |
+| from-email    | The address in the 'From' field                                                         | *yes*     |
+| reply-to      | The address in the 'Reply-To' field                                                     | *yes*     |
+| subject       | The email 'Subject' field                                                               | *yes*     |
+| plain-text    | The plain text version of your email                                                    | *no*      |
+| list-ids      | Comma separated list of sendy list ids                                                  | *no*      |
+| brand-id      | Sendy Brand ID                                                                          | *no*      |
+| send-campaign | Send the email or not (sendy default is 0)                                              | *no*      |
+
+
+When using a YAML config file replace `-` (dash) with `_` (underscore). Options listed in the config file may be overridden by the command line options.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/rssendy/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/rssendy

@@ -0,0 +1,47 @@
+#!/usr/bin/env ruby
+
+require './lib/rssendy'
+require 'slop'
+require 'yaml'
+
+opts = Slop.parse help: true do
+  on 'C', 'config=', 'Path to RSSendy YAML config file'
+  on 'k', 'key=', 'Sendy API Key'
+  on 'u', 'url=', 'URL of sendy app'
+  on 'c', 'content=', 'Nokogiri parser for RSS items'
+  on 'p', 'path=', 'Path to template file'
+  on 'N', 'from-name=', 'Email "from" field'
+  on 'E', 'from-email=', 'Email "email" field'
+  on 'R', 'reply-to=', 'Email "reply-to" field'
+  on 'S', 'subject=', 'Email "subject" field'
+  on 'T', 'plain-text=', 'Email plain text version'
+  on 'I', 'list-ids=', 'Sendy list ids (comma separated) to send to'
+  on 'B', 'brand-id=', 'Sendy Brand ID'
+  on 's', 'send-campaign=', 'Send campaign or not (default false)'
+  on 'version', 'print the version' do
+    puts RSSendy::VERSION
+    exit
+  end
+end
+
+if opts[:config]
+  config = YAML::load(File.read(opts[:config]))
+else
+  config = {}
+end
+
+%i(
+  url path from-name from-email reply-to
+  subject plain-text list-ids brand-id send-campaign
+).each do |opt|
+  config[opt.to_s.split("-").join("_")] = opts[opt] if opts[opt]
+end
+
+config[:api_key] ||= opts[:key]
+
+feed = RSSendy::Feed.new(config)
+
+abort "Feed invalid. Missing fields: #{feed.missing_keys.inspect}" unless feed.valid?
+
+feed.pull!
+feed.post

data/lib/rssendy/version.rb

@@ -0,0 +1,3 @@
+module RSSendy
+  VERSION = "0.1.0"
+end

data/lib/rssendy.rb

@@ -0,0 +1,98 @@
+require 'bundler/setup'
+require "rssendy/version"
+require "nokogiri"
+require "open-uri"
+require "cindy"
+require "erb"
+
+module RSSendy
+  class Feed
+    PROPERTIES = %i{
+      api_key url template host from_name from_email reply_to
+      subject plain_text html_text list_ids brand_id send_campaign
+    }
+    REQUIREMENTS = %i(api_key content url template host from_name from_email reply_to subject)
+
+    InvalidFeedError = Class.new(RuntimeError)
+
+    class <<self
+      PROPERTIES.each do |property|
+        class_eval <<-ENDEVAL
+        def #{property}(val=nil)
+          return @__#{property}__ unless val
+          @__#{property}__ = val
+        end
+        ENDEVAL
+      end
+
+      def content(cont=nil)
+        return @__cont_blk__ unless cont
+        @__cont_blk__ = ->(doc) {doc.instance_eval(cont.sub(/^doc\./, ''))}
+      end
+    end
+
+    def initialize(opts={})
+      PROPERTIES.each do |property|
+        send("#{property}=", opts[property] || self.class.send(property))
+      end
+      @content = opts.fetch(:content, self.class.content)
+    end
+
+    attr_accessor(*PROPERTIES)
+    attr_reader :response, :doc, :items, :html_template
+
+    def content
+      return @content if Proc === @content || @content.nil?
+      _cont = @content.dup
+      @content = ->(doc) { doc.instance_eval(_cont.sub(/^doc\./, '')) }
+    end
+
+    def pull!
+      raise InvalidFeedError, "Feed invalid. Missing keys: #{missing_keys.inspect}" unless valid?
+
+      @response = open(url).read
+      @doc = Nokogiri(@response)
+      @items = content[@doc]
+    end
+
+    def build_template
+      raise InvalidFeedError, "No template set" unless template
+
+      tmpl = ERB.new(File.read(template))
+      @html_template = tmpl.result(binding)
+    end
+
+    def post
+      raise InvalidFeedError, "Feed invalid. Missing keys: #{missing_keys.inspect}" unless valid?
+
+      sendy = ::Cindy.new host, api_key
+      sendy.create_campaign(build_opts)
+    end
+
+    def valid?
+      REQUIREMENTS.all? {|prop| send(prop)}
+    end
+
+    def missing_keys
+      REQUIREMENTS.reject {|prop| send(prop)}
+    end
+
+    private
+
+    def build_opts
+      {
+        from_name: from_name,
+        from_email: from_email,
+        reply_to: reply_to,
+        subject: subject,
+        html_text: build_template
+      }.tap {|opts|
+        %i(plain_text list_ids brand_id send_campaign).each do |property|
+          val = send(property)
+          opts[property] = val if val
+        end
+      }
+    end
+  end
+end
+

data/rssendy.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rssendy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rssendy"
+  spec.version       = RSSendy::VERSION
+  spec.authors       = ["jonah honeyman"]
+  spec.email         = ["jonah@honeyman.org"]
+  spec.summary       = %q{Publish an RSS feed to sendy}
+  spec.description   = %q{Download an RSS feed and push an email template into your hosted sendy app}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "nokogiri", "~> 1.6"
+  spec.add_dependency "slop", "~> 3.6"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.2"
+  spec.add_development_dependency "pry", "~> 0.10"
+end

data/spec/rssendy_spec.rb

@@ -0,0 +1,159 @@
+require "spec_helper"
+
+RSpec.describe RSSendy::Feed do
+  subject do
+    Class.new(RSSendy::Feed) do
+      api_key "hellothar"
+      url "http://hello.com"
+      content %Q[doc.xpath('//content:encoded').map(&:text).map(&:strip)]
+      template File.expand_path("../tmpl.html.erb", __FILE__)
+      host "http://mysendyapp.com/sendy"
+      from_name "root"
+      from_email "root@mysendyapp"
+      reply_to from_email
+      subject "latest news"
+    end
+  end
+
+  let :rss do
+    <<-RSS
+<rss xmlns:content="http://purl.org/rss/1.0/modules/content/" version="2.0">
+  <channel>
+    <item>
+      <content:encoded>
+        <![CDATA[
+          <tr><td>hello</td></tr>
+        ]]>
+      </content:encoded>
+    </item>
+  </channel>
+</rss>
+    RSS
+  end
+
+  let(:doc) { Nokogiri(rss) }
+
+  let(:content) { "<tr><td>hello</td></tr>"}
+
+  let(:invalid_err) { RSSendy::Feed::InvalidFeedError}
+
+  it "exposes :api_key" do
+    expect(subject.api_key).to eql('hellothar')
+  end
+
+  it "exposes :api_key to instances" do
+    expect(subject.new.api_key).to eql('hellothar')
+  end
+
+  it "exposes :url" do
+    expect(subject.url).to eql('http://hello.com')
+  end
+
+  it "exposes :url to instances" do
+    expect(subject.new.url).to eql('http://hello.com')
+  end
+
+  it "exposes :content" do
+    expect(subject.content[doc]).to eql([content])
+  end
+
+  it "exposes :content to instances" do
+    expect(subject.new.content[doc]).to eql([content])
+  end
+
+  it "exposes :template" do
+    expect(subject.template).to eql(File.expand_path('../tmpl.html.erb', __FILE__))
+  end
+
+  it "exposes :template to instances" do
+    expect(subject.new.template).to eql(File.expand_path('../tmpl.html.erb', __FILE__))
+  end
+
+  describe 'instance' do
+    let(:feed) { subject.new }
+
+    describe '#build_template' do
+      context "when valid" do
+        before do
+          allow(feed).to receive(:items).and_return(['hello thar'])
+          feed.build_template
+        end
+
+        it 'builds :html_template' do
+          expect(feed.html_template).to match(%r{<table>((.|\n)*)hello thar((.|\n)*)</table>})
+        end
+      end
+
+      context "when invalid" do
+        before do
+          feed.template = nil
+        end
+
+        it "throws an error" do
+          expect { feed.build_template }.to raise_error(invalid_err)
+        end
+      end
+    end
+
+    describe '#pull!' do
+      context "when valid" do
+        before do
+          allow(feed).to receive_message_chain(:open, :read).and_return(rss)
+          feed.pull!
+        end
+
+        it "sets :response" do
+          expect(feed.response).to eql(rss)
+        end
+
+        it "sets :doc" do
+          expect(feed.doc.to_html).to eql(doc.to_html)
+        end
+
+        it "sets :items" do
+          expect(feed.items).to eql([content])
+        end
+      end
+
+      context "when invalid" do
+        before { feed.url = nil }
+
+        it "throws an error" do
+          expect { feed.pull! }.to raise_error(invalid_err)
+        end
+      end
+    end
+
+    describe "#post" do
+      context "when valid"
+
+      context "when invalid" do
+        before { feed.host = nil }
+
+        it "throws an error" do
+          expect { feed.post }.to raise_error(invalid_err)
+        end
+      end
+    end
+  end
+
+  context 'validity' do
+    let(:opts) {Hash[reqs.map {|r| [r, "foo-#{r}"]}]}
+    subject { RSSendy::Feed.new(opts)}
+
+    context 'valid feed' do
+      let(:reqs) { RSSendy::Feed::REQUIREMENTS }
+      it { is_expected.to be_valid }
+    end
+
+    context 'invalid feed' do
+      RSSendy::Feed::REQUIREMENTS.each do |req|
+        describe "missing #{req}" do
+          let(:reqs) { RSSendy::Feed::REQUIREMENTS.reject {|r| r == req}}
+          it { is_expected.to_not be_valid}
+        end
+      end
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,93 @@
+require "rssendy"
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

data/spec/tmpl.html.erb

@@ -0,0 +1,5 @@
+<table>
+  <% items.each do |item| %>
+    <%= item %>
+  <% end %>
+</table>

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: rssendy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- jonah honeyman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: slop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description: Download an RSS feed and push an email template into your hosted sendy
+  app
+email:
+- jonah@honeyman.org
+executables:
+- rssendy
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/rssendy
+- lib/rssendy.rb
+- lib/rssendy/version.rb
+- rssendy.gemspec
+- spec/rssendy_spec.rb
+- spec/spec_helper.rb
+- spec/tmpl.html.erb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Publish an RSS feed to sendy
+test_files:
+- spec/rssendy_spec.rb
+- spec/spec_helper.rb
+- spec/tmpl.html.erb