sendgrid-web 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d0c66be35eba75ec8a6cfdb0bdf918e2bbe63d3b
+  data.tar.gz: d4713a455c5db0915922186a916f271914940092
+SHA512:
+  metadata.gz: f8aaf092ef851396f5c829f77fa6d7016d94659674ccba3990a31bb29a468f0d05efb6002d8e03cfddd339f732efc988d335a64f72e6def1a65fc741f1af221c
+  data.tar.gz: 51d40f45c36b90c05a3a151a879d96fa07aa649d57692e5de93ce9501dcc98f116bc245dd9fae048a66542403bbe81aefe9b94212d40fba756599393b98f8015

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/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p195

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Darren Coxall
+
+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,29 @@
+# Sendgrid::Web
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sendgrid-web'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sendgrid-web
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/lib/sendgrid/web/blocks.rb

@@ -0,0 +1,12 @@
+class Sendgrid::Web::Blocks < Sendgrid::Web::Client
+
+  def get
+    connection.post('blocks.get.json', default_params)
+  end
+
+  def delete(email: nil)
+    raise ArgumentError.new('Missing required `email` option') if email.nil?
+    connection.post('blocks.delete.json', default_params.merge(email: email))
+  end
+
+end

data/lib/sendgrid/web/bounces.rb

@@ -0,0 +1,16 @@
+class Sendgrid::Web::Bounces < Sendgrid::Web::Client
+
+  def get
+    connection.post('bounces.get.json', default_params)
+  end
+
+  def delete(start_date: nil, end_date: nil, type: nil, email: nil)
+    connection.post('bounces.delete.json',
+      default_params.merge(
+        start_date: start_date,
+        end_date: end_date,
+        type: type,
+        email: email))
+  end
+
+end

data/lib/sendgrid/web/client.rb

@@ -0,0 +1,33 @@
+class Sendgrid::Web::Client
+  def self.configure(&block)
+    @@config = Sendgrid::Web::Configurator.new(&block)
+  end
+
+  def self.config
+    @@config
+  end
+
+  def config
+    @@config ||= Sendgrid::Web::Configurator.new
+  end
+
+  private
+
+  def config=(configurator)
+    @@config = configurator
+  end
+
+  def connection
+    @connection ||= Faraday.new(:url => config.root_url) do |faraday|
+      faraday.request :url_encoded
+      faraday.adapter :typhoeus
+    end
+  end
+
+  def default_params
+    {
+      api_user: config.username,
+      api_key:  config.password
+    }
+  end
+end

data/lib/sendgrid/web/configurator.rb

@@ -0,0 +1,8 @@
+class Sendgrid::Web::Configurator
+  attr_accessor :username, :password, :root_url
+
+  def initialize(&block)
+    self.root_url = 'https://sendgrid.com/api/'
+    yield self if block_given?
+  end
+end

data/lib/sendgrid/web/version.rb

@@ -0,0 +1,5 @@
+module Sendgrid
+  module Web
+    VERSION = "0.0.1"
+  end
+end

data/lib/sendgrid/web.rb

@@ -0,0 +1,13 @@
+require 'faraday'
+require 'typhoeus'
+require 'typhoeus/adapters/faraday'
+require 'sendgrid/web/version'
+
+module Sendgrid
+  module Web
+    autoload :Configurator, 'sendgrid/web/configurator'
+    autoload :Client, 'sendgrid/web/client'
+    autoload :Blocks, 'sendgrid/web/blocks'
+    autoload :Bounces, 'sendgrid/web/bounces'
+  end
+end

data/sendgrid-web.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sendgrid/web/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sendgrid-web"
+  spec.version       = Sendgrid::Web::VERSION
+  spec.authors       = ["Darren Coxall"]
+  spec.email         = ["darren@darrencoxall.com"]
+  spec.description   = 'A ruby 2 optimised API client used to communicate with the Sendgrid Web API.'
+  spec.summary       = 'Interact with the Sendgrid Web API'
+  spec.homepage      = "https://github.com/FreakyDazio/sendgrid-web"
+  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_runtime_dependency "typhoeus", ">= 0.6.3"
+  spec.add_runtime_dependency "faraday"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", ">= 2.14.0"
+end

data/spec/sendgrid/web/blocks_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe Sendgrid::Web::Blocks do
+  before(:all) do
+    Sendgrid::Web::Client.configure do |config|
+      config.username = 'foo'
+      config.password = 'bar'
+    end
+  end
+
+  describe '#get' do
+    let(:test_connection) do
+      Faraday::Adapter::Test::Stubs.new do |stub|
+        stub.post('blocks.get.json') { [200, {}, 'sent blocks.get'] }
+      end
+    end
+
+    before do
+      subject.stub(:connection).and_return(test_connection)
+    end
+
+    it 'makes a json request to /blocks.get.json' do
+      test_connection.should_receive(:post).
+        with('blocks.get.json',
+             hash_including(api_user: 'foo', api_key: 'bar')).
+        and_call_original
+      subject.get
+    end
+  end
+
+  describe '#delete' do
+    let(:test_connection) do
+      Faraday::Adapter::Test::Stubs.new do |stub|
+        stub.post('blocks.delete.json') { [200, {}, 'sent blocks.delete'] }
+      end
+    end
+
+    before do
+      subject.stub(:connection).and_return(test_connection)
+    end
+
+    it 'makes a json request to /blocks.delete.json' do
+      test_connection.should_receive(:post).
+        with('blocks.delete.json',
+             hash_including(api_user: 'foo', api_key: 'bar', email: 'foobar@example.com')).
+        and_call_original
+      subject.delete(email: 'foobar@example.com')
+    end
+  end
+end

data/spec/sendgrid/web/bounces_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe Sendgrid::Web::Bounces do
+  before(:all) do
+    Sendgrid::Web::Client.configure do |config|
+      config.username = 'foo'
+      config.password = 'bar'
+    end
+  end
+
+  describe '#get' do
+    let(:test_connection) do
+      Faraday::Adapter::Test::Stubs.new do |stub|
+        stub.post('bounces.get.json') { [200, {}, 'sent bounces.get'] }
+      end
+    end
+
+    before do
+      subject.stub(:connection).and_return(test_connection)
+    end
+
+    it 'makes a json request to /bounces.get.json' do
+      test_connection.should_receive(:post).
+        with('bounces.get.json',
+             hash_including(api_user: 'foo', api_key: 'bar')).
+        and_call_original
+      subject.get
+    end
+  end
+
+  describe '#delete' do
+    let(:test_connection) do
+      Faraday::Adapter::Test::Stubs.new do |stub|
+        stub.post('bounces.delete.json') { [200, {}, 'sent bounces.delete'] }
+      end
+    end
+
+    before do
+      subject.stub(:connection).and_return(test_connection)
+    end
+
+    it 'makes a json request to /bounces.delete.json' do
+      test_connection.should_receive(:post).
+        with('bounces.delete.json',
+             hash_including(api_user: 'foo', api_key: 'bar', email: 'foobar@example.com')).
+        and_call_original
+      subject.delete(email: 'foobar@example.com')
+    end
+  end
+end

data/spec/sendgrid/web/client_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe Sendgrid::Web::Client do
+  describe '.configure' do
+    subject { Sendgrid::Web::Client.config }
+
+    before do
+      Sendgrid::Web::Client.configure do |config|
+        config.username = 'foo'
+        config.password = 'bar'
+      end
+    end
+
+    it 'creates an instance of Sendgrid::Web::Configurator' do
+      subject.should be_instance_of(Sendgrid::Web::Configurator)
+    end
+
+    it 'passes the block to the configurator object' do
+      subject.username.should eql('foo')
+      subject.password.should eql('bar')
+    end
+  end
+
+  describe '.new' do
+    context 'when pre-configured' do
+      before do
+        Sendgrid::Web::Client.configure do |config|
+          config.username = 'foo'
+          config.password = 'bar'
+        end
+      end
+
+      it 'will have access to configuration' do
+        subject.config.should be_instance_of(Sendgrid::Web::Configurator)
+        subject.config.username.should eql('foo')
+        subject.config.password.should eql('bar')
+      end
+    end
+
+    context 'when not pre-configured' do
+      before { subject.send('config=', nil) }
+
+      it 'will have an empty config object' do
+        subject.config.should be_instance_of(Sendgrid::Web::Configurator)
+        subject.config.username.should be_nil
+        subject.config.password.should be_nil
+      end
+    end
+  end
+end

data/spec/sendgrid/web/configurator_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe Sendgrid::Web::Configurator do
+  describe 'can store username and password' do
+    subject do
+      Sendgrid::Web::Configurator.new do |config|
+        config.username = 'foo'
+        config.password = 'bar'
+      end
+    end
+
+    its(:username) { should eql('foo') }
+    its(:password) { should eql('bar') }
+  end
+
+  it 'sets a default root_url for sendgrid' do
+    subject.root_url.should eql('https://sendgrid.com/api/')
+  end
+
+  it 'can overwrite the api root_url' do
+    configurator = Sendgrid::Web::Configurator.new do |config|
+      config.root_url = 'https://example.com'
+    end
+    configurator.root_url.should eql('https://example.com')
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+require 'sendgrid/web'
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # 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'
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: sendgrid-web
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Darren Coxall
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+- !ruby/object:Gem::Dependency
+  name: faraday
+  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: 2.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+description: A ruby 2 optimised API client used to communicate with the Sendgrid Web
+  API.
+email:
+- darren@darrencoxall.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sendgrid/web.rb
+- lib/sendgrid/web/blocks.rb
+- lib/sendgrid/web/bounces.rb
+- lib/sendgrid/web/client.rb
+- lib/sendgrid/web/configurator.rb
+- lib/sendgrid/web/version.rb
+- sendgrid-web.gemspec
+- spec/sendgrid/web/blocks_spec.rb
+- spec/sendgrid/web/bounces_spec.rb
+- spec/sendgrid/web/client_spec.rb
+- spec/sendgrid/web/configurator_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/FreakyDazio/sendgrid-web
+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.0.2
+signing_key: 
+specification_version: 4
+summary: Interact with the Sendgrid Web API
+test_files:
+- spec/sendgrid/web/blocks_spec.rb
+- spec/sendgrid/web/bounces_spec.rb
+- spec/sendgrid/web/client_spec.rb
+- spec/sendgrid/web/configurator_spec.rb
+- spec/spec_helper.rb