bush_viper 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0e1c9970a2274ff6e271875c26c851a8bd1981b9
+  data.tar.gz: ae42c62b5a8bfd539cfa7c44af05495d25c29a9f
+SHA512:
+  metadata.gz: 90d63322bef5a1cbd9d57aabc850a09bc2fe9bae7608a7d7676491d45b5507a212cae0b34700ada6f0625e643180b45e015d3bb06365fa5b39044a978bddcd5b
+  data.tar.gz: b4059fa86188a4cf321170240b4a1978fd06860695c9a4569a5ff2094a56ebd17115786669a0d95b0b6ba954a15808b930ebbe07a5fe50bd779b175b0ddd383e

data/.gitignore

@@ -0,0 +1,18 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+
+# custom
+.env
+/test/cassettes/

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Kori Roys
+
+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,54 @@
+# BushViper
+
+![](https://github.com/koriroys/images/blob/master/iStock_000053428128_Medium_bush_viper.jpg)
+
+Image credits: [Mark Kostich](http://www.istockphoto.com/photo/african-bush-viper-venomous-snake-53428128)
+
+## Installation
+
+Add this line to the Gemfile of your application:
+
+```ruby
+gem "bush_viper"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bush_viper
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/koriroys/bush_viper/fork )
+2. Create your feature branch (`git checkout -b your-initials/your-new-feature`)
+3. Commit your changes (`git commit -am "Reasoning for feature"`)
+4. Push to the branch (`git push origin your-initials/your-new-feature`)
+5. Create a new Pull Request
+
+## Testing
+
+For running the tests you will need an access token. Since Mendeley offers no way to authenticate without a browser callback flow, the easiest way to get a token is to go to dev.mendeley.com and login. Copy the access_token from the url.
+
+Create a .env file in the main directory, then make it look like this:
+
+    ACCESS_TOKEN=<access_token>
+
+(<access_token> being the token you just copied)
+
+Then, to run the tests:
+
+$ rake
+
+The first time you run the tests, it will make calls to the Mendeley API.
+After that, VCR will kick in and the recorded cassetes will make the tests
+much faster.
+
+I recommend using a throwaway Mendeley account since the tests will create
+quite a few dummy objects using the account.

data/Rakefile

@@ -0,0 +1,20 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+dir = File.dirname(__FILE__)
+
+task :default => :test
+
+Rake::TestTask.new do |t|
+  t.libs << "lib" << "test"
+  t.test_files = Dir.glob("#{dir}/test/**/*_test.rb")
+  t.warning = true
+  t.verbose = true
+end
+
+namespace :test do
+  desc "Clear all test VCR recordings"
+  task :eject do
+    system "rm -rf test/cassettes"
+  end
+end

data/bush_viper.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "bush_viper/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "bush_viper"
+  spec.version       = BushViper::VERSION
+  spec.authors       = ["Kori Roys"]
+  spec.email         = ["kori@koriroys.com"]
+  spec.summary       = %q{Ruby wrapper for Mendeley API}
+  spec.description   = %q{Ruby wrapper for Mendeley API with a really cool name}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday", "~> 0.9"
+  spec.add_dependency "multi_json", "~> 1.0"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "dotenv", "~> 2.0"
+  spec.add_development_dependency "vcr", "~> 2.9"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "minitest-vcr", "~> 1.0"
+  spec.add_development_dependency "webmock", "~> 1.0"
+end

data/lib/bush_viper.rb

@@ -0,0 +1,26 @@
+require "bush_viper/version"
+require "bush_viper/documents"
+require "bush_viper/connection"
+
+module BushViper
+  module Mendeley
+    class API
+      def initialize(token)
+        self.token = token
+      end
+
+      def documents
+        Documents.new(connection)
+      end
+
+      def connection
+        @connection ||= Connection.new(BASE_URL, token)
+      end
+
+      private
+
+      attr_accessor :token
+      BASE_URL = "https://api.mendeley.com/"
+    end
+  end
+end

data/lib/bush_viper/connection.rb

@@ -0,0 +1,43 @@
+require "faraday"
+require "multi_json"
+
+class Connection
+  def initialize(url, token)
+    self.connection = Faraday.new(url: url)
+    self.token = token
+  end
+
+  def get(endpoint)
+    result = connection.get do |request|
+      request.url endpoint
+      request.headers["Authorization"] = "Bearer #{token}"
+    end
+    MultiJson.load(result.body)
+  end
+
+  def post(endpoint, file, filename)
+    result = connection.post do |request|
+      request.url endpoint
+      request.headers["Content-Disposition"] = %Q{attachment; filename="#{filename}"}
+      request.headers["Authorization"] = "Bearer #{token}"
+      request.headers["Content-Type"] = "application/pdf"
+      request.body = file
+    end
+    MultiJson.load(result.body)
+  end
+
+  def patch(endpoint, params)
+    params = MultiJson.dump(params)
+    result = connection.patch do |request|
+      request.url endpoint
+      request.headers["Authorization"] = "Bearer #{token}"
+      request.headers['Content-Type'] = "application/vnd.mendeley-document.1+json"
+      request.body = params
+    end
+    MultiJson.load(result.body)
+  end
+
+  private
+
+  attr_accessor :connection, :token
+end

data/lib/bush_viper/documents.rb

@@ -0,0 +1,31 @@
+class Documents
+  def initialize(connection)
+    self.connection = connection
+  end
+
+  def all
+    connection.get("documents")
+  end
+
+  def types
+    connection.get("document_types")
+  end
+
+  def create(params, filepath: nil, url: nil, filename: nil)
+    if filepath
+      File.open(filepath, "rb") do |file|
+        result = connection.post("documents/", file.read, filename || File.basename(filepath))
+        connection.patch(%Q{documents/#{result["id"]}}, params)
+      end
+    elsif url
+      uri = URI.parse(url)
+      content = Net::HTTP.get(uri)
+      result = connection.post("documents/", content, filename || File.basename(uri.path))
+      connection.patch(%Q{documents/#{result["id"]}}, params)
+    end
+  end
+
+  private
+
+  attr_accessor :connection
+end

data/lib/bush_viper/version.rb

@@ -0,0 +1,3 @@
+module BushViper
+  VERSION = "0.0.1"
+end

data/test.rb

@@ -0,0 +1,8 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "bush_viper"
+
+m = BushViper::Mendeley::API.new("MSwxNDM1MTY0NTU0NzIwLDMzNTAwOTI2MSw3MTIsYWxsLCwsOTRmMzA2NzM2MmU0MTM5NGRiMTM1ZmNhYmFiMTBiNGUzZDk0MS14eGEsRGZfdzNMeWR2ZDVNRkU1TmlDTUtWemtsODVN")
+
+puts m.documents

data/test/lib/bush_viper/documents_test.rb

@@ -0,0 +1,80 @@
+require "test_helper"
+
+describe "documents" do
+  attr_accessor :documents
+
+  before :all do
+    self.documents = BushViper::Mendeley::API.new(ENV["ACCESS_TOKEN"]).documents
+  end
+
+  it "returns empty array if no documents fetched", :vcr do
+    skip
+    assert_equal [], documents.all
+  end
+
+  it "returns a list of documents", :vcr do
+    skip
+    assert_equal ["hello"], documents.all
+  end
+
+  it "returns a list of possible document types", :vcr do
+    possible_document_types = [
+      { "name" => "journal", "description" => "Journal article" },
+      { "name" => "book", "description" => "Book" },
+      { "name" => "generic", "description" => "Generic" },
+      { "name" => "book_section", "description" => "Book section" },
+      { "name" => "conference_proceedings", "description" => "Conference proceedings" },
+      { "name" => "working_paper", "description" => "Working paper" },
+      { "name" => "report", "description" => "Report" },
+      { "name" => "web_page", "description" => "Web page" },
+      { "name" => "thesis", "description" => "Thesis" },
+      { "name" => "magazine_article", "description" => "Magazine article" },
+      { "name" => "statute", "description" => "Statute" },
+      { "name" => "patent", "description" => "Patent" },
+      { "name" => "newspaper_article", "description" => "Newspaper article" },
+      { "name" => "computer_program", "description" => "Computer program" },
+      { "name" => "hearing", "description" => "Hearing" },
+      { "name" => "television_broadcast", "description" => "Television broadcast" },
+      { "name" => "encyclopedia_article", "description" => "Encyclopedia article" },
+      { "name" => "case", "description" => "Case" },
+      { "name" => "film", "description" => "Film" },
+      { "name" => "bill", "description" => "Bill" }
+    ]
+    assert_equal documents.types, possible_document_types
+  end
+
+  it "can upload a document given a filepath", :vcr do
+    params = {
+      title: "Test Title",
+      type: "Generic"
+    }
+    document = documents.create(params, filepath: "test/resources/bush_viper.pdf")
+    assert_equal "Test Title", document["title"]
+    assert_equal "generic", document["type"]
+    assert_equal true, document["file_attached"]
+  end
+
+  it "can upload a document given a url", :vcr do
+    params = {
+      title: "Super Test Title",
+      type: "Journal"
+    }
+    document = documents.create(params, url: "https://raw.githubusercontent.com/koriroys/bush_viper/master/test/resources/bush_viper.pdf")
+    assert_equal "Super Test Title", document["title"]
+    assert_equal "journal", document["type"]
+    assert_equal true, document["file_attached"]
+  end
+
+  it "sets the document title correctly, even with query params", :vcr do
+    params = {
+      type: "Journal"
+    }
+    document = documents.create(params, url: "https://raw.githubusercontent.com/koriroys/bush_viper/master/test/resources/bush_viper.pdf?idontknowwhatImdoing=true/false")
+    puts document["title"]
+    # mendeley api strips off the file extension and makes that the title
+    assert_equal "bush_viper", document["title"]
+    assert_equal "journal", document["type"]
+    assert_equal true, document["file_attached"]
+  end
+end
+

data/test/lib/bush_viper_test.rb

@@ -0,0 +1,11 @@
+require "test_helper"
+
+describe BushViper::Mendeley::API do
+  it "defines the base url constant" do
+    BushViper::Mendeley::API::BASE_URL.must_equal "https://api.mendeley.com/"
+  end
+
+  it "initializes with an access_token" do
+    BushViper::Mendeley::API.new("token").send(:token).must_equal "token"
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,20 @@
+require "minitest/autorun"
+require "minitest/pride"
+require "vcr"
+require "minitest-vcr"
+require "dotenv"
+require "webmock" # because faraday 0.9 and vcr 2.9.3 don't play nice together
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "bush_viper"
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'test/cassettes'
+  c.hook_into :webmock
+  c.allow_http_connections_when_no_cassette = true
+end
+
+MinitestVcr::Spec.configure!
+Dotenv.load

metadata

@@ -0,0 +1,189 @@
+--- !ruby/object:Gem::Specification
+name: bush_viper
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kori Roys
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Ruby wrapper for Mendeley API with a really cool name
+email:
+- kori@koriroys.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bush_viper.gemspec
+- lib/bush_viper.rb
+- lib/bush_viper/connection.rb
+- lib/bush_viper/documents.rb
+- lib/bush_viper/version.rb
+- test.rb
+- test/lib/bush_viper/documents_test.rb
+- test/lib/bush_viper_test.rb
+- test/resources/bush_viper.pdf
+- test/test_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for Mendeley API
+test_files:
+- test/lib/bush_viper/documents_test.rb
+- test/lib/bush_viper_test.rb
+- test/resources/bush_viper.pdf
+- test/test_helper.rb