share_notify 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5b42f6d940f0d9698aab18209fda3281fa075b22
-  data.tar.gz: 97b9636b7251fa113ec6d17b6180dacb835c49e5
+  metadata.gz: 992d71908ef077371053a44b67c63bb32fceae00
+  data.tar.gz: ae4841bd49c0c2f381da680e374684060cfc8004
 SHA512:
-  metadata.gz: 466c07b62a15401a679a8b6de8b1a6d2f51925761c7cb6c0f02e64397f8e886ac20481d2e8a54d7725b82dfa2bef60e76a6e68cba2a6a9656925085ee83b171a
-  data.tar.gz: 6915142aa07475d78d524e3bbf2dbe484cd9f4f4c8e991b563f6f3a2ce4e7d6b1947dc892fc724b345b03a1a0d6b1eb30a09dbfaff10500393c742982983ffb9
+  metadata.gz: 8970e6026ce4d30738cff7ea4f4914066ad108f8483665ffa4d619c018497049d7d924d3b498826fe7ec69d316e462079b755bd88d75fe8da83182254aacac8f
+  data.tar.gz: 99efeef394b0ffbfb8c002e30a933b38ee7edcac5bbce895493e02f57d526d4c94a4c240d556da660b56eefe48e4371191dcb3f90bc9e4bf22d750c24138eec3

data/.gitignore

@@ -8,3 +8,4 @@
 /spec/reports/
 /tmp/
 /bin/
+.ruby-version

data/.rubocop.yml

@@ -0,0 +1,112 @@
+require: rubocop-rspec
+
+AllCops:
+  DisplayCopNames: true
+  Include:
+    - '**/Rakefile'
+
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Exclude:
+
+Metrics/PerceivedComplexity:
+  Exclude:
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ClassLength:
+  Exclude:
+
+Metrics/ModuleLength:
+  Exclude:
+
+Style/BlockDelimiters:
+  Exclude:
+    - 'spec/**/*'
+
+Style/BlockEndNewline:
+  Exclude:
+    - 'spec/**/*'
+
+Style/MultilineBlockLayout:
+  Exclude:
+    - 'spec/**/*'
+
+Style/IndentationConsistency:
+  EnforcedStyle: rails
+
+Style/CollectionMethods:
+  PreferredMethods:
+    collect: 'map'
+    collect!: 'map!'
+    inject: 'reduce'
+    detect: 'find'
+    find_all: 'select'
+
+Style/WordArray:
+  Enabled: false
+
+Style/RegexpLiteral:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/HashSyntax:
+  Exclude:
+
+Style/LineEndConcatenation:
+  Exclude:
+
+Style/PredicateName:
+  Exclude:
+
+Style/GlobalVars:
+  Exclude:
+    - 'spec/**/*'
+
+Style/SingleLineBlockParams:
+  Enabled: false
+
+Style/ClassVars:
+  Exclude:
+
+Style/SignalException:
+  Enabled: false
+
+RSpec/ExampleWording:
+  CustomTransform:
+    be: is
+    have: has
+    not: does not
+    NOT: does NOT
+  IgnoredWords:
+    - only
+
+RSpec/FilePath:
+  Enabled: false
+
+RSpec/InstanceVariable:
+  Enabled: false
+
+RSpec/DescribeClass:
+  Exclude:
+
+Style/FileName:
+  Exclude:
+
+Style/VariableName:
+  Exclude:
+    - 'lib/share_notify/push_document.rb'

data/.travis.yml

@@ -1,4 +1,8 @@
 language: ruby
+cache: bundler
 rvm:
-  - 2.2.3
-before_install: gem install bundler -v 1.11.2
+  - 2.3.0
+notifications:
+  irc:
+    channels:
+      - "irc.freenode.org#projecthydra"

data/Gemfile

@@ -4,3 +4,5 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'byebug'
+gem 'rubocop', require: false
+gem 'rubocop-rspec', require: false

data/README.md

@@ -1,8 +1,7 @@
 # ShareNotify
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/share_notify`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Provides basic tools for creating documents to send to SHARENotify's Push API as well as query for documents
+using SHARE Search.
 
 ## Installation
 
@@ -22,20 +21,77 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Configuration
+
+In order to push data to Share, you will need a token from OSF. Once obtained, you'll put this in a config folder
+in your Rails application or project as `config/share_notify.yml`:
+
+    ---
+    host: "https://osf.io"
+    token: "MY_TOKEN"
+
+### Pushing Data
+
+First, create a `PushDocument` with the required metadata:
+
+    >  document = ShareNotify::PushDocument.new("http://my.document.id/1234")
+    >  document.title = "Some Title"
+    >  document.add_contributor(name: "My Name", email: "myemail@example.com")
+    >  document.valid?
+    => true
+
+Then send the document to Share using the `API` class:
+
+    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>
+
+    api = ShareNotify::API.new
+    api.search([query terms])
+
+#### Extending Your Classes
+
+Assuming your data class has a `#url` method, and that url is used to create the initial `PushDocument`
+that's sent to Share, you can include `ShareNotify::Metadata` to query Share and determine 
+if the document is already present in ShareNotify's Search API.
+
+    class MyDataClass
+      include ShareNotify::Metadata
 
-## Development
+      def url
+        "http://my.document.id/1234"
+      end
+    end
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+    >  document = MyDataClass.find("1234")
+    >  document.share_notified?
+    => true
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+Note: It may take 24 hours or more before documents that have been initially pushed to Share will appear
+in the Search API.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/share_notify. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+### Hydra Developers
 
+For Hydra developers, or anyone with a signed CLA, please clone the repo and submit PRs via
+feature branches. If you don't have rights to projecthydra-labs and do have a signed
+CLA, please send a note to hydra-tech@googlegroups.com.
 
-## License
+1. Clone 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 a new Pull Request
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+### Non-Hydra Developers
 
+Anyone is welcome to use this software and report issues.
+In order to merge any work contributed, you'll need to sign a contributor license agreement.
+For more information on signing a CLA, please contact `legal@projecthyra.org`
+# Project Hydra
+This software has been developed by and is brought to you by the Hydra community.  Learn more at the
+[Project Hydra website](http://projecthydra.org)

data/Rakefile

@@ -1,6 +1,16 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+desc "Run style checker"
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.requires << 'rubocop-rspec'
+  task.fail_on_error = true
+end
+
+desc "Run continuous integration tests"
+task ci: [:rubocop, :spec]
+
+task default: :ci

data/lib/share_notify/api.rb

@@ -9,13 +9,13 @@ class ShareNotify::API
 
   attr_reader :headers, :response
 
-  base_uri ShareNotify.config.fetch("host", "https://staging.osf.io")
+  base_uri ShareNotify.config.fetch('host', 'https://staging.osf.io')
 
   # @param [String] token is optional but some actions will not be successful without it
   def initialize(_token = nil)
     @headers = {
-      "Authorization" => "Token #{ShareNotify.config.fetch('token', nil)}",
-      "Content-Type"  => "application/json"
+      'Authorization' => "Token #{ShareNotify.config.fetch('token', nil)}",
+      'Content-Type'  => 'application/json'
     }
   end
 
@@ -37,11 +37,11 @@ class ShareNotify::API
   private
 
     def api_data_point
-      "/api/v1/share/data"
+      '/api/v1/share/data'
     end
 
     def api_search_point
-      "/api/v1/share/search/"
+      '/api/v1/share/search/'
     end
 
     def with_timeout(&_block)

data/lib/share_notify/push_document.rb

@@ -6,7 +6,7 @@ module ShareNotify
     # @param [String] uri that identifies the resource
     def initialize(uri)
       @uris = ShareUri.new(uri)
-      @providerUpdatedDateTime = Time.now.utc.strftime("%Y-%m-%dT%H:%M:%SZ")
+      @providerUpdatedDateTime = Time.now.utc.strftime('%Y-%m-%dT%H:%M:%SZ')
       @contributors = []
     end
 
@@ -21,7 +21,7 @@ module ShareNotify
     # @param [DateTime or Time] time object that can be formatted in to the correct representation
     def updated=(time)
       return unless time.respond_to?(:strftime)
-      @providerUpdatedDateTime = time.utc.strftime("%Y-%m-%dT%H:%M:%SZ")
+      @providerUpdatedDateTime = time.utc.strftime('%Y-%m-%dT%H:%M:%SZ')
     end
 
     # @param [String] version identifying the version of the resource

data/lib/share_notify/search_response.rb

@@ -5,17 +5,17 @@ module ShareNotify
 
     # @param [HTTParty::Response] response returned from ShareNotify::API
     def initialize(response)
-      raise ArgumentError, "API response is nil" if response.nil?
+      fail ArgumentError, 'API response is nil' if response.nil?
       @status = response.code
       @response = response.parsed_response
     end
 
     def count
-      response.fetch("count", 0)
+      response.fetch('count', 0)
     end
 
     def docs
-      @docs ||= response.fetch("results", []).map { |d| Document.new(d) }
+      @docs ||= response.fetch('results', []).map { |d| Document.new(d) }
     end
 
     class Document
@@ -26,45 +26,45 @@ module ShareNotify
       end
 
       def contributors
-        doc.fetch("contributors", [])
+        doc.fetch('contributors', [])
       end
 
       def title
-        doc.fetch("title", nil)
+        doc.fetch('title', nil)
       end
 
       def properties
-        doc.fetch("shareProperties", nil)
+        doc.fetch('shareProperties', nil)
       end
 
       def doc_id
         return if properties.nil?
-        properties.fetch("docID", nil)
+        properties.fetch('docID', nil)
       end
 
       def source
         return if properties.nil?
-        properties.fetch("source", nil)
+        properties.fetch('source', nil)
       end
 
       def updated
-        time_string = doc.fetch("providerUpdatedDateTime", nil)
+        time_string = doc.fetch('providerUpdatedDateTime', nil)
         return if time_string.nil?
         Time.parse(time_string)
       end
 
       def uris
-        doc.fetch("uris", nil)
+        doc.fetch('uris', nil)
       end
 
       def canonical_uri
         return if uris.nil?
-        uris.fetch("canonicalUri", nil)
+        uris.fetch('canonicalUri', nil)
       end
 
       def provider_uris
         return if uris.nil?
-        uris.fetch("providerUris", [])
+        uris.fetch('providerUris', [])
       end
     end
   end

data/lib/share_notify/version.rb

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

data/lib/share_notify.rb

@@ -1,7 +1,7 @@
-require "share_notify/version"
-require "active_support"
+require 'share_notify/version'
+require 'active_support'
 require 'active_support/core_ext'
-require "httparty"
+require 'httparty'
 
 module ShareNotify
   autoload :API,            'share_notify/api'
@@ -16,7 +16,7 @@ module ShareNotify
       elsif value.is_a?(String)
         @config = YAML.load(File.read(value))
       else
-        raise InitializationError, "Unrecognized configuration: #{value.inspect}"
+        fail InitializationError, "Unrecognized configuration: #{value.inspect}"
       end
     end
 
@@ -28,7 +28,8 @@ module ShareNotify
     end
 
     def root
-      File.dirname(__dir__)
+      return File.dirname(__dir__) unless defined?(Rails)
+      Rails.root
     end
   end
 end

data/share_notify.gemspec

@@ -4,29 +4,28 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'share_notify/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "share_notify"
+  spec.name          = 'share_notify'
   spec.version       = ShareNotify::VERSION
-  spec.authors       = ["Adam Wead"]
-  spec.email         = ["amsterdamos@gmail.com"]
+  spec.authors       = ['Adam Wead']
+  spec.email         = ['amsterdamos@gmail.com']
 
-  spec.summary       = %q{Provides basic API integration with ShareNotify}
-  spec.description   = %q{Provides basic API integration with ShareNotify}
-  spec.homepage      = "https://github.com/projecthydra-labs/share_notify"
-  spec.license       = "APACHE2"
+  spec.summary       = 'Provides basic API integration with ShareNotify'
+  spec.description   = 'Provides basic API integration with ShareNotify'
+  spec.homepage      = 'https://github.com/projecthydra-labs/share_notify'
+  spec.license       = 'APACHE2'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency "activesupport"
-  spec.add_dependency "httparty"
+  spec.add_dependency 'activesupport'
+  spec.add_dependency 'httparty'
 
-
-  spec.add_development_dependency "bundler", "~> 1.11"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "rspec-its"
-  spec.add_development_dependency "vcr"
-  spec.add_development_dependency "webmock"
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rspec-its'
+  spec.add_development_dependency 'vcr'
+  spec.add_development_dependency 'webmock'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: share_notify
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Adam Wead
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-03 00:00:00.000000000 Z
+date: 2016-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -131,6 +131,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE