share_notify 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 992d71908ef077371053a44b67c63bb32fceae00
-  data.tar.gz: ae4841bd49c0c2f381da680e374684060cfc8004
+  metadata.gz: 19538bad0fafdc5a725b731da4c8d5867c902af6
+  data.tar.gz: 1d67b18db273434e8f609b95752419e40c1bc2aa
 SHA512:
-  metadata.gz: 8970e6026ce4d30738cff7ea4f4914066ad108f8483665ffa4d619c018497049d7d924d3b498826fe7ec69d316e462079b755bd88d75fe8da83182254aacac8f
-  data.tar.gz: 99efeef394b0ffbfb8c002e30a933b38ee7edcac5bbce895493e02f57d526d4c94a4c240d556da660b56eefe48e4371191dcb3f90bc9e4bf22d750c24138eec3
+  metadata.gz: 5e2ea02ee49d794049bd4342444783f7984303894a42b0b061ec82269000d5eca1b7edfe6e0928e540178ed979e5322eb6eea2b3cabb2f79e750e612dd729b87
+  data.tar.gz: 3c4071b8d2167cc9235683946300cb9dfe2dcc9a097a36e4c9fb55075bc56bcc763f2c8e3c457e447b8ff7163cf85f15e1f4cb3b633b1a8fffc6b87342c0bbf7

data/.rubocop.yml

@@ -1,5 +1,3 @@
-require: rubocop-rspec
-
 AllCops:
   DisplayCopNames: true
   Include:

data/Gemfile

@@ -3,6 +3,7 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in share_notify.gemspec
 gemspec
 
-gem 'byebug'
+gem 'byebug', require: false
 gem 'rubocop', require: false
-gem 'rubocop-rspec', require: false
+# Removed until https://github.com/nevir/rubocop-rspec/issues/78 is resolved
+#gem 'rubocop-rspec', require: false

data/README.md

@@ -1,5 +1,9 @@
 # ShareNotify
 
+[![Gem Version](https://badge.fury.io/rb/share_notify.svg)](https://badge.fury.io/rb/share_notify)
+[![Build Status](https://api.travis-ci.org/projecthydra-labs/share_notify.png?branch=master)](https://travis-ci.org/projecthydra-labs/share_notify)
+[![Apache 2.0 License](http://img.shields.io/badge/APACHE2-license-blue.svg)](./LICENSE)
+
 Provides basic tools for creating documents to send to SHARENotify's Push API as well as query for documents
 using SHARE Search.
 
@@ -45,6 +49,18 @@ Then send the document to Share using the `API` class:
     api = ShareNotify::API.new
     api.post(document.to_share.to_json)
 
+### Deleting Data
+
+Same as above, but adding an additional "delete" property informs the Share API that this
+document should be delete from the Search API:
+
+    >  document = ShareNotify::PushDocument.new("http://my.document.id/1234")
+    >  document.title = "Some Title"
+    >  document.add_contributor(name: "My Name", email: "myemail@example.com")
+    >  document.delete
+    >  api = ShareNotify::API.new
+    >  api.post(document.to_share.to_json)
+
 ### Querying
 
 You can query Share's Search API using the terms outlined in <https://osf.io/dajtq/wiki/SHARE%20Search>
@@ -71,7 +87,7 @@ if the document is already present in ShareNotify's Search API.
     => true
 
 Note: It may take 24 hours or more before documents that have been initially pushed to Share will appear
-in the Search API.
+in or be deleted from the Search API.
 
 ## Contributing
 

data/Rakefile

@@ -6,7 +6,7 @@ RSpec::Core::RakeTask.new(:spec)
 
 desc "Run style checker"
 RuboCop::RakeTask.new(:rubocop) do |task|
-  task.requires << 'rubocop-rspec'
+  # task.requires << 'rubocop-rspec'
   task.fail_on_error = true
 end
 

data/lib/share_notify.rb

@@ -8,6 +8,7 @@ module ShareNotify
   autoload :Metadata,       'share_notify/metadata'
   autoload :PushDocument,   'share_notify/push_document'
   autoload :SearchResponse, 'share_notify/search_response'
+  autoload :NotificationQueryService, 'share_notify/notification_query_service'
 
   class << self
     def configure(value)

data/lib/share_notify/exceptions.rb

@@ -0,0 +1,10 @@
+module ShareNotify
+  class RuntimeError < ::RuntimeError
+  end
+
+  class InitializationError < RuntimeError
+    def initialize(context, method_names)
+      super("Expected #{context.inspect} to respond to #{method_names.inspect}")
+    end
+  end
+end

data/lib/share_notify/metadata.rb

@@ -1,26 +1,17 @@
 # Queries the SHARE search api for an existing record. This assumes the class into which this
 # module is included responds to #url and that in turn is mapped to the docID of the Share
 # document that was originally uploaded via the SHARE push API.
+#
+# @see ShareNotify::NotificationQueryService for details of interface expectations
 module ShareNotify::Metadata
   extend ActiveSupport::Concern
+  extend Forwardable
 
-  def share_notified?
-    return if response.status != 200
-    return false if response.count < 1
-    response.docs.first.doc_id == url
-  end
-
-  def call
-    api.search("shareProperties.docID:\"#{url}\"")
-  end
+  def_delegator :notification_query_service, :share_notified?
 
   private
 
-    def response
-      @response ||= ShareNotify::SearchResponse.new(call)
-    end
-
-    def api
-      @api ||= ShareNotify::API.new
+    def notification_query_service
+      @notification_query_service ||= ShareNotify::NotificationQueryService.new(self)
     end
 end

data/lib/share_notify/notification_query_service.rb

@@ -0,0 +1,38 @@
+require 'share_notify/exceptions'
+
+module ShareNotify
+  # Queries the SHARE search api for an existing record. This assumes the class into which this
+  # module is included responds to #url and that in turn is mapped to the docID of the Share
+  # document that was originally uploaded via the SHARE push API.
+  #
+  # @see ShareNotify::PushDocument
+  class NotificationQueryService
+    def initialize(context)
+      self.context = context
+    end
+
+    def share_notified?
+      response = search("shareProperties.docID:\"#{context.url}\"")
+      return if response.status != 200
+      return false if response.count < 1
+      response.docs.first.doc_id == context.url
+    end
+
+    private
+
+      def search(string)
+        ShareNotify::SearchResponse.new(api.search(string))
+      end
+
+      def api
+        ShareNotify::API.new
+      end
+
+      attr_reader :context
+
+      def context=(input)
+        raise ShareNotify::InitializationError.new(input, [:url]) unless input.respond_to?(:url)
+        @context = input
+      end
+  end
+end

data/lib/share_notify/push_document.rb

@@ -1,12 +1,20 @@
 module ShareNotify
   class PushDocument
-    attr_reader :uris, :contributors, :providerUpdatedDateTime, :version
-    attr_accessor :title
+    attr_reader :uris,
+                :contributors,
+                :providerUpdatedDateTime,
+                :version,
+                :publisher,
+                :languages,
+                :tags,
+                :otherProperties
+    attr_accessor :title, :description
 
     # @param [String] uri that identifies the resource
-    def initialize(uri)
+    def initialize(uri, datetime = nil)
+      datetime = (datetime.is_a?(Time) || datetime.is_a?(DateTime)) ? datetime : Time.now
       @uris = ShareUri.new(uri)
-      @providerUpdatedDateTime = Time.now.utc.strftime('%Y-%m-%dT%H:%M:%SZ')
+      @providerUpdatedDateTime = datetime.utc.strftime('%Y-%m-%dT%H:%M:%SZ')
       @contributors = []
     end
 
@@ -35,10 +43,32 @@ module ShareNotify
       @contributors << contributor
     end
 
+    # @param [Hash] publisher containing required keys for publisher
+    def publisher=(publisher)
+      return false unless publisher.keys.include?(:name)
+      @publisher = publisher
+    end
+
+    # @param [Array<String>] languages list of languages
+    def languages=(languages)
+      return false unless languages.is_a?(Array)
+      @languages = languages
+    end
+
+    # @param [Array<String>] tags list of tags
+    def tags=(tags)
+      return false unless tags.is_a?(Array)
+      @tags = tags
+    end
+
     def to_share
       { jsonData: self }
     end
 
+    def delete
+      @otherProperties = [OtherProperty.new("status", status: ["deleted"])]
+    end
+
     class ShareUri
       attr_reader :canonicalUri, :providerUris
 
@@ -47,5 +77,14 @@ module ShareNotify
         @providerUris = [uri]
       end
     end
+
+    class OtherProperty
+      attr_reader :name, :property
+
+      def initialize(*args)
+        @name = args.shift
+        @properties = args.shift
+      end
+    end
   end
 end

data/lib/share_notify/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module ShareNotify
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.2.0'.freeze
 end

data/share_notify.gemspec

@@ -23,6 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'httparty'
 
   spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'factory_girl'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rspec-its'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: share_notify
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Adam Wead
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-04 00:00:00.000000000 Z
+date: 2016-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  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: rake
   requirement: !ruby/object:Gem::Requirement
@@ -140,7 +154,9 @@ files:
 - config/share_notify.yml
 - lib/share_notify.rb
 - lib/share_notify/api.rb
+- lib/share_notify/exceptions.rb
 - lib/share_notify/metadata.rb
+- lib/share_notify/notification_query_service.rb
 - lib/share_notify/push_document.rb
 - lib/share_notify/search_response.rb
 - lib/share_notify/version.rb