freya 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 21e31ab534884c80678d4a173a9a5286dfb90752
+  data.tar.gz: 66310b314fa61c8de0ec5adc55513b2446dcf5d8
+SHA512:
+  metadata.gz: aea7175c75d44841c900a6106fb4062469750ee6732455d0d9310dd8ad1d4dc0315da44049cd15493823b78097c9e3d120b4496eb2d308abc9fa44c43923ab4f
+  data.tar.gz: e8419e2371c433917c0bf0818ccb6c6a9dcfe899ea67e54263f76b20f36aa9ba5fc1afe03874820303464e03ef6b01170c5e4aa629d70b6192a9fa0898c5125f

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in freya.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Matteo Depalo
+
+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,42 @@
+# Freya
+
+A minimal email link generator
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'freya'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install freya
+
+## Usage
+
+Create a yml file containing the bodies of your emails.
+
+```yml
+test:
+    email: This is a test email
+```
+
+Then you create a link to this email like this:
+
+```ruby
+mail_to Freya::Email.new(name:'test email', to: 'test@test.com', subject: 'test_subject).link, 'Email'
+```
+
+You can access mail bodies using the `name` attribute separating nodes with white spaces.
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

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

data/freya.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'freya/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "freya"
+  spec.version       = Freya::VERSION
+  spec.authors       = ["Matteo Depalo"]
+  spec.email         = ["matteodepalo@gmail.com"]
+  spec.description   = %q{Minimal email generator}
+  spec.summary       = %q{Minimal email generator}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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 'rails'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'pry'
+end

data/lib/freya.rb

@@ -0,0 +1,43 @@
+require 'freya/version'
+require 'active_support/core_ext/hash'
+require 'yaml'
+require 'rails'
+
+module Freya
+  class Template
+    def self.config=(config)
+      @config ||= config
+    end
+
+    def self.config
+      @config
+    end
+
+    def initialize
+      return unless File.exists?(File.join(Rails.root, 'config', 'emails.yml'))
+      self.class.config ||= HashWithIndifferentAccess.new(YAML.load(IO.read(File.join(Rails.root, 'config', 'emails.yml'))))
+    end
+
+    def [](name)
+      name.to_s.split(' ').inject(self.class.config) { |result, n| result.fetch(n) }
+    end
+  end
+
+  class Email < OpenStruct
+    def link
+      link = to + '?'
+
+      link_params = ['subject', 'cc', 'body'].inject([]) do |link_params, param_name|
+        param = send(param_name)
+        link_params << param.to_query(param_name).gsub('+', '%20') if param
+        link_params
+      end
+
+      link + link_params.join("&")
+    end
+
+    def body
+      Template.new[name]
+    end
+  end
+end

data/lib/freya/version.rb

@@ -0,0 +1,3 @@
+module Freya
+  VERSION = "0.0.4"
+end

data/spec/freya_spec.rb

@@ -0,0 +1,87 @@
+require 'freya'
+require 'pry'
+
+describe Freya::Email do
+  before do
+    File.stub(exists?: true)
+    Rails.stub(root: 'freya')
+    Freya.send(:remove_const, 'Template')
+    load 'lib/freya.rb'
+  end
+
+  describe 'methods' do
+    before do
+      IO.stub(read:
+        <<-EOS
+        test_email: This is the test email
+        EOS
+      )
+    end
+
+    describe '#link' do
+      it 'builds a mail link with options like to, cc and the email body' do
+        Freya::Email.new(name: 'test_email', subject: 'subject', to: 'test@test.com', cc: ['test2@test.com']).link.should eq(
+          'test@test.com?subject=subject&cc%5B%5D=test2%40test.com&body=This%20is%20the%20test%20email'
+        )
+      end
+    end
+
+    describe '#body' do
+      it 'returns a email body based on the name' do
+        Freya::Email.new(name: 'test_email').body.should eq('This is the test email')
+      end
+
+      it 'returns a email body based on names separated by space' do
+        IO.stub(read:
+          <<-EOS
+          test:
+            email: This is the test email
+          EOS
+        )
+
+        Freya::Email.new(name: 'test email').body.should eq('This is the test email')
+      end
+
+      it 'raises exception if the key is not found' do
+        expect {
+          Freya::Email.new(name: 'wrong_name').body
+        }.to raise_error
+      end
+    end
+  end
+
+  describe Freya::Template do
+    before do
+      IO.stub(read:
+        <<-EOS
+        test_email: This is the first test email
+        test_email2: This is the second test email
+        EOS
+      )
+    end
+
+    it 'responds to emails defined in emails.yml' do
+      Freya::Template.new[:test_email].should be_present
+      Freya::Template.new[:test_email2].should be_present
+    end
+
+    it 'its methods return an email containing the body of the corresponding emails' do
+      Freya::Template.new[:test_email].should eq('This is the first test email')
+      Freya::Template.new[:test_email2].should eq('This is the second test email')
+    end
+
+    it 'allows access to nested email templates' do
+      IO.stub(read:
+        <<-EOS
+        test1:
+          email: This is the first test email
+        test2:
+          email: This is the second test email
+        EOS
+      )
+
+      Freya::Template.new[:test1][:email].should eq('This is the first test email')
+      Freya::Template.new[:test2][:email].should eq('This is the second test email')
+    end
+  end
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: freya
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- Matteo Depalo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Minimal email generator
+email:
+- matteodepalo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- freya.gemspec
+- lib/freya.rb
+- lib/freya/version.rb
+- spec/freya_spec.rb
+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.1.9
+signing_key: 
+specification_version: 4
+summary: Minimal email generator
+test_files:
+- spec/freya_spec.rb