4me-sdk 1.1.7 → 1.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e60520cbd73635cb830ffbe38668234a3a626561066fd8b63936e69f80ddbe79
-  data.tar.gz: 35409fc13cf51fcea5f445347e5fff9e4fdf0bde66f67cb4ee6e42d3b8bda215
+  metadata.gz: aba8de45bcc385f1f8ffedfce680f58cb5c73865510798712d7d8c382ecbd9bf
+  data.tar.gz: 1ffb444710f94ad590aa4943589465e028ad7cf1957bd5546fd93fe158871c6e
 SHA512:
-  metadata.gz: 02ba8ae69285fe81b9915546be3c8ba07298d6cc55620fcd830e2c8ff33429f786d7cf33685c08f90e658dade1d7a30c17031ef89f98c3b1478cbcf976e65f55
-  data.tar.gz: 16da929f4143f8412faf517e1b8941d932ef8a98508b8cc2a8708db12d481481058118212320089b7a8679c65bb3490089e6f5567bf1329d573206a541d130ff
+  metadata.gz: bdd2c6e55c547a2b13ca893a73e3167d77adee143e53e396b48d8712cfb8d7e148f0f3b10090c3b20691e22b20ddad4a1593d6f8e374880a98c9f8b71abfbe85
+  data.tar.gz: d63bc178ea462a8b4691ad2d63c25ca48ae5735820d398047dfe98ff450be1a6d3f6c8aa8e27c30829afb9753b5213a6f55c0539d1ba03f134908ea8a59ae4f3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    4me-sdk (1.1.6)
+    4me-sdk (1.1.8)
       activesupport (>= 4.2)
       gem_config (>= 0.3)
       mime-types (>= 3.0)
@@ -16,7 +16,7 @@ GEM
       tzinfo (~> 1.1)
     addressable (2.5.2)
       public_suffix (>= 2.0.2, < 4.0)
-    concurrent-ruby (1.1.4)
+    concurrent-ruby (1.1.5)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.3)
@@ -28,7 +28,7 @@ GEM
     json (2.1.0)
     mime-types (3.2.2)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2018.0812)
+    mime-types-data (3.2019.0331)
     minitest (5.11.3)
     public_suffix (3.0.3)
     rake (12.3.1)
@@ -71,4 +71,4 @@ DEPENDENCIES
   webmock (~> 2)
 
 BUNDLED WITH
-   1.16.2
+   1.17.3

data/README.md

@@ -213,6 +213,14 @@ response = Sdk4me::Client.new.put('requests/416621', {
 })
 ```
 
+It is also possible to add inline attachments as follows:
+```
+response = Sdk4me::Client.new.put('requests/416621', {
+  note: 'Here is some inspiration for you: [attachment:/tmp/images/puppy.png]'
+})
+```
+Note that only images are accepted as inline attachments.
+
 If an attachment upload fails, the errors are logged but the `post` or `put` request will still be sent to 4me without the
 failed attachments. To receive exceptions add `attachments_exception: true` to the data.
 

data/lib/sdk4me/client.rb

@@ -211,7 +211,8 @@ module Sdk4me
     def expand_header(header = {})
       header = DEFAULT_HEADER.merge(header)
       header['X-4me-Account'] = option(:account) if option(:account)
-      header['AUTHORIZATION'] = 'Basic ' + ["#{option(:api_token)}:x"].pack('m*').gsub(/\s/, '')
+      token_and_password = option(:api_token).include?(':') ? option(:api_token) : "#{option(:api_token)}:x"
+      header['AUTHORIZATION'] = 'Basic ' + [token_and_password].pack('m*').gsub(/\s/, '')
       if option(:source)
         header['X-4me-Source'] = option(:source)
         header['HTTP_USER_AGENT'] = option(:source)

data/lib/sdk4me/client/attachments.rb

@@ -8,21 +8,64 @@ module Sdk4me
       @client = client
     end
 
-    # upload the attachments in :attachments to 4me and return the data with the uploaded attachment info
+    # upload the attachments and return the data with the uploaded attachment info
+    # Two flavours available
+    #  * data[:attachments]
+    #  * data[:note] containing text with '[attachment:/tmp/images/green_fuzz.jpg]'
     def upload_attachments!(path, data)
-      raise_exceptions = !!data.delete(:attachments_exception)
+      upload_options = {
+        raise_exceptions: !!data.delete(:attachments_exception),
+        attachments_field: attachments_field(path),
+      }
+      uploaded_attachments = upload_normal_attachments!(path, data, upload_options)
+      uploaded_attachments += upload_inline_attachments!(path, data, upload_options)
+      # jsonify the attachments, if any were uploaded
+      data[upload_options[:attachments_field]] = uploaded_attachments.compact.to_json if uploaded_attachments.compact.any?
+    end
+
+    private
+
+    # upload the attachments in :attachments to 4me and return the data with the uploaded attachment info
+    def upload_normal_attachments!(path, data, upload_options)
       attachments = [data.delete(:attachments)].flatten.compact
-      return if attachments.empty?
+      return [] if attachments.empty?
 
-      # retrieve the upload configuration for this record from 4me
-      storage = @client.get(path =~ /\d+$/ ? path : "#{path}/new", {attachment_upload_token: true}, @client.send(:expand_header))[:storage_upload]
-      report_error("Attachments not allowed for #{path}", raise_exceptions) and return unless storage
+      upload_options[:storage] ||= storage(path, upload_options[:raise_exceptions])
+      return [] unless upload_options[:storage]
 
-      # upload each attachment and store the {key, filesize} has in the note_attachments parameter
-      data[attachments_field(path)] = attachments.map {|attachment| upload_attachment(storage, attachment, raise_exceptions) }.compact.to_json
+      attachments.map do |attachment|
+        upload_attachment(upload_options[:storage], attachment, upload_options[:raise_exceptions])
+      end
     end
 
-    private
+    INLINE_ATTACHMENT_REGEXP = /\[attachment:([^\]]+)\]/.freeze
+    # upload any '[attachment:/tmp/images/green_fuzz.jpg]' in :note text field to 4me as inline attachment and add the s3 key to the text
+    def upload_inline_attachments!(path, data, upload_options)
+      text_field = upload_options[:attachments_field].to_s.gsub('_attachments', '').to_sym
+      return [] unless (data[text_field] || '') =~ INLINE_ATTACHMENT_REGEXP
+
+      upload_options[:storage] ||= storage(path, upload_options[:raise_exceptions])
+      return [] unless upload_options[:storage]
+
+      attachments = []
+      data[text_field] = data[text_field].gsub(INLINE_ATTACHMENT_REGEXP) do |full_match|
+        attachment_details = upload_attachment(upload_options[:storage], $~[1], upload_options[:raise_exceptions])
+        if attachment_details
+          attachments << attachment_details.merge(inline: true)
+          "![](#{attachment_details[:key]})" # magic markdown for inline attachments
+        else
+          full_match
+        end
+      end
+      attachments
+    end
+
+    def storage(path, raise_exceptions)
+      # retrieve the upload configuration for this record from 4me
+      storage = @client.get(path =~ /\d+$/ ? path : "#{path}/new", {attachment_upload_token: true}, @client.send(:expand_header))[:storage_upload]
+      report_error("Attachments not allowed for #{path}", raise_exceptions) unless storage
+      storage
+    end
 
     def attachments_field(path)
       case path

data/lib/sdk4me/client/version.rb

@@ -1,5 +1,5 @@
 module Sdk4me
   class Client
-    VERSION = '1.1.7'
+    VERSION = '1.1.8'
   end
 end

data/spec/lib/sdk4me/attachments_spec.rb

@@ -8,69 +8,135 @@ describe Sdk4me::Attachments do
   end
 
   context 'upload_attachments!' do
-    it 'should not do anything when no :attachments are present' do
-      expect(@attachments.upload_attachments!('/requests', {status: :in_progress})).to be_nil
-    end
+    context 'normal' do
+      it 'should not do anything when no :attachments are present' do
+        expect(@attachments.upload_attachments!('/requests', {status: :in_progress})).to be_nil
+      end
 
-    it 'should not do anything when :attachments is nil' do
-      expect(@attachments.upload_attachments!('/requests', {attachments: nil})).to be_nil
-    end
+      it 'should not do anything when :attachments is nil' do
+        expect(@attachments.upload_attachments!('/requests', {attachments: nil})).to be_nil
+      end
 
-    it 'should not do anything when :attachments is empty' do
-      expect(@attachments.upload_attachments!('/requests', {attachments: []})).to be_nil
-      expect(@attachments.upload_attachments!('/requests', {attachments: [nil]})).to be_nil
-    end
+      it 'should not do anything when :attachments is empty' do
+        expect(@attachments.upload_attachments!('/requests', {attachments: []})).to be_nil
+        expect(@attachments.upload_attachments!('/requests', {attachments: [nil]})).to be_nil
+      end
 
-    it 'should show a error if no attachment may be uploaded' do
-      stub_request(:get, 'https://api.4me.com/v1/sites/1?attachment_upload_token=true').with(basic_auth: ['secret', 'x']).to_return(body: {name: 'site 1'}.to_json)
-      expect_log('Attachments not allowed for /sites/1', :error)
-      expect(@attachments.upload_attachments!('/sites/1', {attachments: ['file1.png']})).to be_nil
-    end
+      it 'should show a error if no attachment may be uploaded' do
+        stub_request(:get, 'https://api.4me.com/v1/sites/1?attachment_upload_token=true').with(basic_auth: ['secret', 'x']).to_return(body: {name: 'site 1'}.to_json)
+        expect_log('Attachments not allowed for /sites/1', :error)
+        expect(@attachments.upload_attachments!('/sites/1', {attachments: ['file1.png']})).to be_nil
+      end
 
-    it 'should raise an exception if no attachment may be uploaded' do
-      stub_request(:get, 'https://api.4me.com/v1/sites/1?attachment_upload_token=true').with(basic_auth: ['secret', 'x']).to_return(body: {name: 'site 1'}.to_json)
-      message = 'Attachments not allowed for /sites/1'
-      expect{ @attachments.upload_attachments!('/sites/1', {attachments: ['file1.png'], attachments_exception: true}) }.to raise_error(::Sdk4me::UploadFailed, message)
-    end
+      it 'should raise an exception if no attachment may be uploaded' do
+        stub_request(:get, 'https://api.4me.com/v1/sites/1?attachment_upload_token=true').with(basic_auth: ['secret', 'x']).to_return(body: {name: 'site 1'}.to_json)
+        message = 'Attachments not allowed for /sites/1'
+        expect{ @attachments.upload_attachments!('/sites/1', {attachments: ['file1.png'], attachments_exception: true}) }.to raise_error(::Sdk4me::UploadFailed, message)
+      end
 
-    it 'should add /new to the path for new records' do
-      stub_request(:get, 'https://api.4me.com/v1/sites/new?attachment_upload_token=true').with(basic_auth: ['secret', 'x']).to_return(body: {missing: 'storage'}.to_json)
-      expect_log('Attachments not allowed for /sites', :error)
-      expect(@attachments.upload_attachments!('/sites', {attachments: ['file1.png']})).to be_nil
-    end
+      it 'should add /new to the path for new records' do
+        stub_request(:get, 'https://api.4me.com/v1/sites/new?attachment_upload_token=true').with(basic_auth: ['secret', 'x']).to_return(body: {missing: 'storage'}.to_json)
+        expect_log('Attachments not allowed for /sites', :error)
+        expect(@attachments.upload_attachments!('/sites', {attachments: ['file1.png']})).to be_nil
+      end
 
-    [ [:requests,          :note],
-      [:problems,          :note],
-      [:contracts,         :remarks],
-      [:cis,               :remarks],
-      [:flsas,             :remarks],
-      [:slas,              :remarks],
-      [:service_instances, :remarks],
-      [:service_offerings, :summary],
-      [:any_other_model,   :note]].each do |model, attribute|
-
-      it "should replace :attachments with :#{attribute}_attachments after upload at /#{model}" do
-        stub_request(:get, "https://api.4me.com/v1/#{model}/new?attachment_upload_token=true").with(basic_auth: ['secret', 'x']).to_return(body: {storage_upload: 'conf'}.to_json)
-        expect(@attachments).to receive(:upload_attachment).with('conf', 'file1.png', false).ordered{ 'uploaded file1.png' }
-        expect(@attachments).to receive(:upload_attachment).with('conf', 'file2.zip', false).ordered{ 'uploaded file2.zip' }
-        data = {leave: 'me alone', attachments: %w(file1.png file2.zip)}
-        @attachments.upload_attachments!("/#{model}", data)
+      [ [:requests,          :note],
+        [:problems,          :note],
+        [:contracts,         :remarks],
+        [:cis,               :remarks],
+        [:flsas,             :remarks],
+        [:slas,              :remarks],
+        [:service_instances, :remarks],
+        [:service_offerings, :summary],
+        [:any_other_model,   :note]].each do |model, attribute|
+
+        it "should replace :attachments with :#{attribute}_attachments after upload at /#{model}" do
+          stub_request(:get, "https://api.4me.com/v1/#{model}/new?attachment_upload_token=true").with(basic_auth: ['secret', 'x']).to_return(body: {storage_upload: 'conf'}.to_json)
+          expect(@attachments).to receive(:upload_attachment).with('conf', 'file1.png', false).ordered{ 'uploaded file1.png' }
+          expect(@attachments).to receive(:upload_attachment).with('conf', 'file2.zip', false).ordered{ 'uploaded file2.zip' }
+          data = {leave: 'me alone', attachments: %w(file1.png file2.zip)}
+          @attachments.upload_attachments!("/#{model}", data)
+          expect(data[:attachments]).to be_nil
+          expect(data[:leave]).to eq('me alone')
+          expect(data[:"#{attribute}_attachments"]).to eq(['uploaded file1.png', 'uploaded file2.zip'].to_json)
+        end
+      end
+
+      it 'should set raise_exception flag to true when :attachments_exception is set' do
+        stub_request(:get, 'https://api.4me.com/v1/requests/new?attachment_upload_token=true').with(basic_auth: ['secret', 'x']).to_return(body: {storage_upload: 'conf'}.to_json)
+        expect(@attachments).to receive(:upload_attachment).with('conf', 'file1.png', true).ordered{ 'uploaded file1.png' }
+        data = {leave: 'me alone', attachments: 'file1.png', attachments_exception: true}
+        @attachments.upload_attachments!('/requests', data)
         expect(data[:attachments]).to be_nil
+        expect(data[:attachments_exception]).to be_nil
         expect(data[:leave]).to eq('me alone')
-        expect(data[:"#{attribute}_attachments"]).to eq(['uploaded file1.png', 'uploaded file2.zip'].to_json)
+        expect(data[:note_attachments]).to eq(['uploaded file1.png'].to_json)
       end
     end
 
-    it 'should set raise_exception flag to true when :attachments_exception is set' do
-      stub_request(:get, 'https://api.4me.com/v1/requests/new?attachment_upload_token=true').with(basic_auth: ['secret', 'x']).to_return(body: {storage_upload: 'conf'}.to_json)
-      expect(@attachments).to receive(:upload_attachment).with('conf', 'file1.png', true).ordered{ 'uploaded file1.png' }
-      data = {leave: 'me alone', attachments: 'file1.png', attachments_exception: true}
-      @attachments.upload_attachments!('/requests', data)
-      expect(data[:attachments]).to be_nil
-      expect(data[:attachments_exception]).to be_nil
-      expect(data[:leave]).to eq('me alone')
-      expect(data[:note_attachments]).to eq(['uploaded file1.png'].to_json)
+    context 'inline' do
+      it 'should not do anything when no [attachment:...] is present in the note' do
+        expect(@attachments.upload_attachments!('/requests', {note: '[attachmen:/type]'})).to be_nil
+      end
+
+      it 'should not do anything when attachment is empty' do
+        expect(@attachments.upload_attachments!('/requests', {note: '[attachment:]'})).to be_nil
+      end
+
+      it 'should show a error if no attachment may be uploaded' do
+        stub_request(:get, 'https://api.4me.com/v1/sites/1?attachment_upload_token=true').with(basic_auth: ['secret', 'x']).to_return(body: {name: 'site 1'}.to_json)
+        expect_log('Attachments not allowed for /sites/1', :error)
+        expect(@attachments.upload_attachments!('/sites/1', {note: '[attachment:file1.png]'})).to be_nil
+      end
+
+      it 'should raise an exception if no attachment may be uploaded' do
+        stub_request(:get, 'https://api.4me.com/v1/sites/1?attachment_upload_token=true').with(basic_auth: ['secret', 'x']).to_return(body: {name: 'site 1'}.to_json)
+        message = 'Attachments not allowed for /sites/1'
+        expect{ @attachments.upload_attachments!('/sites/1', {note: '[attachment:file1.png]', attachments_exception: true}) }.to raise_error(::Sdk4me::UploadFailed, message)
+      end
+
+      it 'should add /new to the path for new records' do
+        stub_request(:get, 'https://api.4me.com/v1/sites/new?attachment_upload_token=true').with(basic_auth: ['secret', 'x']).to_return(body: {missing: 'storage'}.to_json)
+        expect_log('Attachments not allowed for /sites', :error)
+        expect(@attachments.upload_attachments!('/sites', {note: '[attachment:file1.png]'})).to be_nil
+      end
+
+      [ [:requests,          :note],
+        [:problems,          :note],
+        [:contracts,         :remarks],
+        [:cis,               :remarks],
+        [:flsas,             :remarks],
+        [:slas,              :remarks],
+        [:service_instances, :remarks],
+        [:service_offerings, :summary],
+        [:any_other_model,   :note]].each do |model, attribute|
+
+        it "should replace :attachments with :#{attribute}_attachments after upload at /#{model}" do
+          stub_request(:get, "https://api.4me.com/v1/#{model}/new?attachment_upload_token=true").with(basic_auth: ['secret', 'x']).to_return(body: {storage_upload: 'conf'}.to_json)
+          expect(@attachments).to receive(:upload_attachment).with('conf', 'file1.png', false).ordered{ {key: 'uploaded file1.png'} }
+          expect(@attachments).to receive(:upload_attachment).with('conf', 'file2.zip', false).ordered{ {key: 'uploaded file2.zip'} }
+          data = {leave: 'me alone', attribute => '[attachment:file1.png] and [attachment:file2.zip]'}
+          @attachments.upload_attachments!("/#{model}", data)
+          expect(data[:attachments]).to be_nil
+          expect(data[:leave]).to eq('me alone')
+          expect(data[:"#{attribute}_attachments"]).to eq([{key: 'uploaded file1.png', inline: true}, {key: 'uploaded file2.zip', inline: true}].to_json)
+          expect(data[:"#{attribute}"]).to eq('![](uploaded file1.png) and ![](uploaded file2.zip)')
+        end
+      end
+
+      it 'should set raise_exception flag to true when :attachments_exception is set' do
+        stub_request(:get, 'https://api.4me.com/v1/requests/new?attachment_upload_token=true').with(basic_auth: ['secret', 'x']).to_return(body: {storage_upload: 'conf'}.to_json)
+        expect(@attachments).to receive(:upload_attachment).with('conf', 'file1.png', true).ordered{ {key: 'uploaded file1.png'} }
+        data = {leave: 'me alone', note: '[attachment:file1.png]', attachments_exception: true}
+        @attachments.upload_attachments!('/requests', data)
+        expect(data[:attachments]).to be_nil
+        expect(data[:attachments_exception]).to be_nil
+        expect(data[:leave]).to eq('me alone')
+        expect(data[:note_attachments]).to eq([{key: 'uploaded file1.png', inline: true}].to_json)
+        expect(data[:note]).to eq('![](uploaded file1.png)')
+      end
     end
+
   end
 
   context 'upload_attachment' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: 4me-sdk
 version: !ruby/object:Gem::Version
-  version: 1.1.7
+  version: 1.1.8
 platform: ruby
 authors:
 - 4me
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-01 00:00:00.000000000 Z
+date: 2020-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gem_config