sendgrid_cli 0.1.0

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/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+# uncomment this line if your project needs to run something other than `rake`:
+script: bundle exec rspec spec

data/Gemfile

@@ -0,0 +1,9 @@
+source :rubygems
+gemspec
+
+gem 'httparty'
+gem 'json'
+
+group :development do
+  gem 'rspec'
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 David Ryder
+
+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,48 @@
+# SendgridCli
+
+[![Build Status](https://secure.travis-ci.org/libryder/sendgrid_cli.png)](http://travis-ci.org/libryder/sendgrid_cli)
+
+This is a basic implementation for a command line interface to the Sendgrid API. It is currently limited
+to the Spam Reports function. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sendgrid_cli'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sendgrid_cli
+
+## Usage
+
+Sendgrid spam reports utility. 
+
+Allows you to manage and view your list of spam reports.
+
+```
+sendgrid config user <api_username>    :: Configure api username for gem use
+sendgrid config pass <api_secret>      :: Configure api password for gem use
+sendgrid get [<email>]                 :: Get entire list or single blocked recipient.
+sendgrid delete <email>                :: Delete single recipient from blocked recipient list.
+```
+
+####Note
+ ```config``` is required to be run before API will work. Config is stored in
+
+```
+~/.sendgrid_cli.yaml
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/bin/sendgrid

@@ -0,0 +1,84 @@
+#!/usr/bin/env ruby
+require 'sendgrid_cli'
+require 'fileutils'
+require 'yaml'
+
+class SendgridExec
+  include SendgridCli
+
+  def initialize
+    begin
+      @config = YAML::load( File.open(File.expand_path('~/.sendgrid_cli.yaml' )))
+    rescue Errno::ENOENT
+      FileUtils.touch(File.expand_path('~/.sendgrid_cli.yaml'))
+      @config = {'user' => nil, 'pass' => nil}
+    end
+  end
+  
+  def build_config
+    case ARGV[1] 
+    when 'user'
+      user = ARGV[2]
+      pass ||= @config['pass']
+    when 'pass'
+      pass = ARGV[2]
+      user ||= @config['user']
+    else
+      raise "Invalid config option: '#{ARGV[2]}'. Try 'help' for usage."
+    end
+
+    File.open(File.expand_path('~/.sendgrid_cli.yaml'), "w") do |f|
+      f.write({'user' => user, 'pass' => pass}.to_yaml)
+    end
+  end
+
+  def run(action, email=nil)
+
+    if action == 'config'
+      build_config
+      puts "\nConfiguration successful.\n"
+      exit
+    end
+
+    api = SpamReport.new(@config['user'], @config['pass'])
+
+    case action
+    when 'get'
+      api.get(email)
+    when 'help'
+      help
+    when 'delete'
+      if email
+        api.delete(email)
+      else
+        raise "Please provide an email address to delete."
+      end
+    else
+      raise "Invalid argument: #{action}. Use 'help' for usage."
+    end
+  end
+
+  def print_results(result)
+    puts result
+    puts ''
+    puts "-----#{result.count} results------"
+  end
+
+  def help
+    puts "\nSendgrid spam reports utility. \n\nAllows you to manage and view your list of spam reports."
+
+    puts "\nUSAGE:\n"
+    
+    puts "\nconfig user <api_username>  :: Configure api username for gem use"
+    puts "config pass <api_secret>      :: Configure api password for gem use" 
+    puts "get [<email>]                 :: Get entire list or single blocked recipient."
+    puts "delete <email>                :: Delete single recipient from blocked recipient list.\n\n"
+    exit
+  end
+end
+
+cli = SendgridExec.new
+response = cli.run(ARGV[0], ARGV[1])
+
+email_list = response.map { |result| result['email'] }
+cli.print_results(email_list)

data/lib/sendgrid_cli/interface.rb

@@ -0,0 +1,31 @@
+module SendgridCli
+
+  class Interface
+
+    def initialize(user, pass)
+      @api_user = user
+      @api_pass = pass
+      if @api_pass.nil? || @api_user.nil?
+        raise "Please configure gem before use. Try 'help' for usage."
+      end
+    end
+
+  public
+    def get(command, email=nil)
+      query_api(command, 'get', email)
+    end
+
+    def delete(command, email)
+      query_api(command, 'delete', email)
+    end
+
+  private
+    def query_api(command, action, email=nil)
+      args = "&email=#{email}" unless email.nil?
+      send_grid_url = "https://sendgrid.com/api/#{command}.#{action}.json?api_user=#{@api_user}&api_key=#{@api_pass}#{args}"
+      
+      response = HTTParty.get(send_grid_url)
+      JSON.parse(response.body)
+    end
+  end
+end

data/lib/sendgrid_cli/spam_report.rb

@@ -0,0 +1,14 @@
+module SendgridCli
+  class SpamReport < Interface
+
+  public
+    def get(email=nil)
+      super('spamreports', email)
+    end
+
+    def delete(email)
+      super('spamreports', email)
+    end
+
+  end
+end

data/lib/sendgrid_cli/version.rb

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

data/lib/sendgrid_cli.rb

@@ -0,0 +1,8 @@
+require "sendgrid_cli/version"
+require 'httparty'
+require 'json'
+
+module SendgridCli
+  require 'sendgrid_cli/interface'
+  require 'sendgrid_cli/spam_report'
+end

data/sendgrid_cli.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/sendgrid_cli/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["David Ryder"]
+  gem.email         = ["david@libryder.com"]
+  gem.description   = %q{Simple command line interface into sendgrid's web API}
+  gem.summary       = %q{}
+  gem.homepage      = "http://github.com/libryder/sendgrid_cli"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "sendgrid_cli"
+  gem.require_paths = ["lib"]
+  gem.version       = SendgridCli::VERSION
+  
+  gem.add_dependency 'httparty'
+  gem.add_dependency 'json'
+end

data/spec/lib/interface_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+require 'sendgrid_cli'
+
+module SendgridCli
+  describe Interface do
+    let(:email) { 'test@example.com' }
+    let(:api_response) { [{ ip: '127.0.0.1', email: email }] }
+
+    subject { SendgridCli::Interface }
+
+    before { subject.stub(query_api: api_response) }
+    
+    context 'when gem is not configured' do
+      it 'should raise an exception when not configured' do 
+        expect { subject.new(nil, nil) }.to raise_error
+      end
+    end
+
+    context 'when gem is configured' do
+      let(:klass) { subject.new(email, 'password') }
+
+      describe '#get' do
+        it 'call query_api' do
+          klass.should_receive(:query_api).with('spamreports', 'get', email)
+          klass.get('spamreports', email)
+        end
+      end
+
+      describe '#delete' do
+        it 'should return a successful status' do
+          klass.should_receive(:query_api).with('spamreports', 'delete', email)
+          klass.delete('spamreports', email)
+        end
+      end
+    end
+
+  end
+end

data/spec/lib/spam_report_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+require 'sendgrid_cli'
+
+module SendgridCli
+  describe SpamReport do
+    let(:email) { 'test@example.com' }
+
+    subject { SendgridCli::SpamReport.new(email, 'password') }
+
+    describe '#get' do
+      it 'call super with correct arugments' do
+        SendgridCli::Interface.any_instance.should_receive(:get).with('spamreports', 'get', email)
+        subject.get(email)
+      end
+    end
+
+    describe '#delete' do
+      it 'should return a successful status' do
+        SendgridCli::Interface.any_instance.should_receive(:delete).with('spamreports', 'get', email)
+        subject.delete(email)
+      end
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# 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,97 @@
+--- !ruby/object:Gem::Specification
+name: sendgrid_cli
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- David Ryder
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple command line interface into sendgrid's web API
+email:
+- david@libryder.com
+executables:
+- sendgrid
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/sendgrid
+- lib/sendgrid_cli.rb
+- lib/sendgrid_cli/interface.rb
+- lib/sendgrid_cli/spam_report.rb
+- lib/sendgrid_cli/version.rb
+- sendgrid_cli.gemspec
+- spec/lib/interface_spec.rb
+- spec/lib/spam_report_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/libryder/sendgrid_cli
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: ''
+test_files:
+- spec/lib/interface_spec.rb
+- spec/lib/spam_report_spec.rb
+- spec/spec_helper.rb