upcloudify 0.2.1 → 0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e8c0d88922162a79fa51516d8ee28087ceb3e124
-  data.tar.gz: fea1862b2ec0f7bf85bd7cc580a69ac252f0939c
+  metadata.gz: c0182ed646b50b0a9f00e18e9d857e0a7e89b060
+  data.tar.gz: 69771857a3449b01acb736d4f331b6f2109ff3d1
 SHA512:
-  metadata.gz: 8fcd85a8ed939f8b4ecde3d696469e09fb383a95a346b22da7347100c93c921ad6e6143332ac3fc5325adb9446d8fc13492db5dbeddb13731331666c1dec32c0
-  data.tar.gz: f5c9bb1804cb00f2b3a6b13448af228f1327a3e2e6c4e06dc2f8568327f994a0354ad84e969753739771b9514520dc1ff5f57f307bb85b8a5028a4121e4d3557
+  metadata.gz: 83697d6c71b144a0af6e4a065677c18e34b74427655ae296c37646ea3c65d8f541c1b25f769b87f566b499bd3fe08a822f234ee50c15e45822027d0967c6c038
+  data.tar.gz: 1a09825874d8c783f3e1900f0efd2f9750dc4e181231a969ca2af5ebb1404529dfde89d84bf8f3e27fe5bbcca9065cac65286429984ecdacf3acc6db949f8b21

data/README.md

@@ -18,6 +18,8 @@ Or install it yourself as:
 
 ## Usage
 
+Version 0.3 started using required named parameters and so will only run on Ruby version 2.2 and higher.
+
 Configure the app:
 
 ``` ruby

data/Rakefile

@@ -1 +1,9 @@
 require "bundler/gem_tasks"
+
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require 'upcloudify'
+  ARGV.clear
+  IRB.start
+end

data/lib/notifiers/slack.rb

@@ -0,0 +1,30 @@
+class Upcloudify
+  module Notifiers
+    class Slack
+      require "httparty"
+
+      def initialize(to: nil, url:)
+        @url = url
+        @to = to
+      end
+
+      def notify(text: nil)
+        HTTParty.post(
+          @url,
+          headers: {"Content-Type" => content_type},
+          body: payload.merge(text: text).to_json
+        )
+      end
+
+      def payload
+        { channel: @to }
+      end
+
+      private
+
+      def content_type
+        "application/json"
+      end
+    end
+  end
+end

data/lib/upcloudify/version.rb

@@ -1,3 +1,3 @@
-module Upcloudify
-  VERSION = "0.2.1"
+class Upcloudify
+  VERSION = "0.3"
 end

data/lib/upcloudify.rb

@@ -1,4 +1,6 @@
 require "upcloudify/version"
+require "notifiers/slack"
+
 require 'gem_config'
 require 'zip/zip'
 require 'zippy'
@@ -6,21 +8,32 @@ require 'pony'
 require 'fog'
 require 'date'
 
-module Upcloudify
-  include GemConfig::Base
+class Upcloudify
+
+  def initialize(uploader:, notifier:)
+    @uploader = uploader
+    @notifier = notifier
+  end
 
-  with_configuration do
-    has :aws_access_key_id, default: ENV['AWS_ACCESS_KEY_ID']
-    has :aws_secret_access_key, default: ENV['AWS_SECRET_ACCESS_KEY']
-    has :aws_directory
+  def upload_and_notify(filename:, attachment:, message: "%s")
+    expiration = (Date.today + 7).to_time
+    file = @uploader.upload(filename, attachment)
+    @notifier.notify(text: message % file.url(expiration))
   end
 
   class S3
 
+    include GemConfig::Base
+    with_configuration do
+      has :aws_access_key_id, default: ENV['AWS_ACCESS_KEY_ID']
+      has :aws_secret_access_key, default: ENV['AWS_SECRET_ACCESS_KEY']
+      has :aws_directory
+    end
+
     def initialize(options = {
         aws_access_key_id: Upcloudify.configuration.aws_access_key_id,
         aws_secret_access_key: Upcloudify.configuration.aws_secret_access_key,
-        aws_directory: Upcloudify.configuration.aws_directory
+        aws_directory: Upcloudify.configuration.aws_directory,
     })
       raise ArgumentError, "aws_access_key_id is required" unless options[:aws_access_key_id]
       raise ArgumentError, "aws_secret_access_key is required" unless options[:aws_secret_access_key]
@@ -80,7 +93,6 @@ module Upcloudify
         body: (options[:body] || '') + file.url(expiration) + ' '
 
     end
-
   end
 
 end

data/scratch

@@ -0,0 +1,2 @@
+
+https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX

data/spec/notifiers/slack_spec.rb

@@ -0,0 +1,50 @@
+require "notifiers/slack"
+
+describe Upcloudify::Notifiers::Slack do
+  Given(:recipient) { "@parasquid" }
+  Given(:klass) { Upcloudify::Notifiers::Slack }
+  Given(:slack_api_url) { "https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX"}
+  context "sanity check" do
+    Given(:token) { "token" }
+    When(:instance) { klass.new(to: recipient, url: slack_api_url) }
+    Then { instance != nil }
+  end
+
+  Given(:instance) { klass.new(to: recipient, url: slack_api_url) }
+  describe "slack endpoint connectivity" do
+    context "a connection is made to the slack server" do
+      Given!(:slack_api_stub) { stub_request(:post, slack_api_url) }
+      When { instance.notify }
+      Then { expect(slack_api_stub).to have_been_requested }
+    end
+
+    context "the content type is application/json" do
+      Given!(:slack_api_stub) {
+        stub_request(:post, slack_api_url).
+          with(headers: {"Content-Type" => "application/json"})
+      }
+      When { instance.notify }
+      Then { expect(slack_api_stub).to have_been_requested }
+    end
+
+    context "a custom message can be sent for the notification" do
+      Given!(:slack_api_stub) {
+        stub_request(:post, slack_api_url).
+          with(
+            headers: {"Content-Type" => "application/json"},
+            body: { text: "abc", channel: recipient }
+          )
+      }
+      When { instance.notify(text: "abc") }
+      Then { expect(slack_api_stub).to have_been_requested }
+    end
+  end
+
+  describe "payload" do
+    Given(:instance) { klass.new(to: recipient, url: slack_api_url) }
+    context "the payload contains the username to be notified" do
+      When(:payload) { instance.payload }
+      Then { expect(payload).to include(channel: recipient) }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,3 +1,6 @@
+require 'rspec/given'
+require 'webmock/rspec'
+
 # 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

data/spec/upcloudify_spec.rb

@@ -44,4 +44,60 @@ describe Upcloudify::S3 do
       expect(subject.cloud(connection)).to eq files
     end
   end
+end
+
+describe Upcloudify do
+  describe ".upload_and_notify" do
+    Given(:test_file_class) {
+      class TestFile
+        def url(expiration)
+          "filename link"
+        end
+      end
+      TestFile
+    }
+    Given(:test_file) { test_file_class.new }
+    Given(:uploader) { double("uploader") }
+    Given { allow(uploader).to receive(:upload).and_return(test_file) }
+    Given(:notifier) { double("notifier") }
+    Given(:klass) { Upcloudify }
+    Given(:instance) { klass.new(uploader: uploader, notifier: notifier) }
+    context "notifications" do
+      Given { expect(uploader).to receive(:upload) }
+      context "notifies the user" do
+        When { expect(notifier).to receive(:notify) }
+        Then {
+          expect {
+            instance.upload_and_notify(filename: 'abc', attachment: '123')
+          }.not_to raise_error
+        }
+      end
+      context "the notification has a custom message" do
+        When { expect(notifier).to receive(:notify).with({text: "hi"}) }
+        Then {
+          expect {
+            instance.upload_and_notify(filename: 'abc', attachment: '123', message: "hi")
+          }.not_to raise_error
+        }
+      end
+      context "the notification can merge the file url" do
+        When { expect(notifier).to receive(:notify).with({text: "your report <filename link>"}) }
+        Then {
+          expect {
+            instance.upload_and_notify(filename: 'abc', attachment: '123', message: "your report <%s>")
+          }.not_to raise_error
+        }
+      end
+    end
+    context "uploads the file" do
+      Given { allow(notifier).to receive(:notify) }
+      When { expect(uploader).to receive(:upload) }
+      Then {
+        expect {
+          instance.upload_and_notify(filename: 'abc', attachment: '123')
+        }.not_to raise_error
+      }
+    end
+  end
+
 end

data/upcloudify.gemspec

@@ -25,11 +25,14 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "pry"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "rspec-given"
+  spec.add_development_dependency "webmock"
 
   spec.add_dependency 'gem_config'
   spec.add_dependency 'pony'
   spec.add_dependency 'zippy'
   spec.add_dependency 'zip-zip'
   spec.add_dependency 'fog'
+  spec.add_dependency 'httparty'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: upcloudify
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: '0.3'
 platform: ruby
 authors:
 - parasquid
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-23 00:00:00.000000000 Z
+date: 2016-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,6 +80,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-given
+  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: webmock
+  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: gem_config
   requirement: !ruby/object:Gem::Requirement
@@ -150,6 +178,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  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'
 description: |-
   Upcloudify simplifies the process for uploading
                             attachments to the cloud and emailing the recipient
@@ -167,11 +209,14 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- lib/notifiers/slack.rb
 - lib/upcloudify.rb
 - lib/upcloudify/version.rb
 - sample_app/Gemfile
 - sample_app/sample.rb
 - sample_app/views/index.erb
+- scratch
+- spec/notifiers/slack_spec.rb
 - spec/spec_helper.rb
 - spec/upcloudify_spec.rb
 - upcloudify.gemspec
@@ -195,10 +240,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Upload a file to the cloud and email a link for the attachment
 test_files:
+- spec/notifiers/slack_spec.rb
 - spec/spec_helper.rb
 - spec/upcloudify_spec.rb