zotero 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cecbf49d8b9d2c207c4c2342f2f1ba9da6e26fe4
+  data.tar.gz: 24855d1fe43c8bd4255f202642fec4d8d68881ce
+SHA512:
+  metadata.gz: 7ef858cda6d9df3644b9eed223347b2493e0f42ba56527273f96b30bcbb2109e1bfef5c18b72a9dd4a7c9ae591bb4b8568d240ceb0b685e05fa14076ac1d3ab4
+  data.tar.gz: d0af586f213c4832eead6122bea6a462bbea102d289343bf431ec6dccbfb7bbed5e8cfdb0b640e730a81e3837f70de1f56f061f098fa3b5ea8e1e2b412795d44

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in zotero.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Joshua Mostafa
+
+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,39 @@
+# Zotero
+
+Provide easy Ruby access to Zotero, for e.g. generating online bibliographies
+and reading lists.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'zotero'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install zotero
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+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.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/zotero.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "zotero"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/zotero.rb

@@ -0,0 +1,8 @@
+require 'active_support/core_ext/hash/keys'
+
+module Zotero
+  module Entities; end
+  module Styles; end
+end
+
+Gem.find_files('Zotero/**/*.rb').each { |path| require path }

data/lib/zotero/api.rb

@@ -0,0 +1,16 @@
+require 'rest-client'
+require 'json'
+
+class Zotero::Api
+  def initialize(user_id, key)
+    @user_id = user_id
+    @key = key
+  end
+
+  def get(path_fragment)
+    ::JSON.parse(RestClient.get("https://api.zotero.org/users/#{@user_id}/#{path_fragment}", {
+      'Zotero-API-Version' => 3,
+      'Zotero-API-Key' => @key
+    }).body)
+  end
+end

data/lib/zotero/entities/collection.rb

@@ -0,0 +1,59 @@
+class Zotero::Entities::Collection 
+  attr_reader :name
+
+  def initialize(api, data)
+    @api = api
+
+    @key = data['key']
+    @no_entries = 0 == data['meta']['numItems']
+    @no_collections = 0 == data['meta']['numCollections']
+    @name = data['data']['name']
+  end
+
+  def collections
+    @collections ||= get_collections
+  end
+
+  def entries
+    @entries ||= get_entries
+  end
+
+  def to_h
+    {
+      name: name, 
+      collections: collections.collect(&:to_h),
+      entries: entries.collect(&:to_h)
+    }.symbolize_keys
+  end
+
+  # Eager-load all entries and child collections
+  def preload
+    entries
+    collections.each &:preload
+    nil
+  end
+
+  private 
+
+  def get_collections
+    return [] if @no_collections
+
+    @api.get("collections/#{@key}/collections").collect {|data|
+      ::Zotero::Entities::Collection.new @api, data
+    }.sort {|a, b|
+      a.name <=> b.name
+    }
+  end
+
+  def get_entries
+    return [] if @no_entries
+
+    @api.get("collections/#{@key}/items").select {|data|
+      'attachment' != data['data']['itemType']
+    }.collect { |data|
+      ::Zotero::Entities::Entry.new data
+    }.sort {|a, b|
+      a.creator_sort_string <=> b.creator_sort_string
+    }
+  end
+end

data/lib/zotero/entities/creator.rb

@@ -0,0 +1,29 @@
+class Zotero::Entities::Creator 
+  attr_reader :last_name, :first_name, :kind
+
+  def initialize(data)
+    @last_name = data['lastName']
+    @first_name = data['firstName']
+    @kind = data['creatorType']
+  end
+
+  def author? 
+    'author' == kind
+  end
+
+  def editor? 
+    'editor' == kind
+  end
+
+  def translator?
+    'translator' == kind
+  end
+
+  def to_h
+    {
+      first_name: first_name,
+      last_name: last_name,
+      kind: kind
+    }.symbolize_keys
+  end
+end

data/lib/zotero/entities/entry.rb

@@ -0,0 +1,77 @@
+require 'active_support/core_ext/string/inflections'
+
+#TODO: rationalise these, find list of Zotero item types & attributes
+ENTRY_ATTS = %w(
+  access_date
+  blog_title
+  book_title
+  date
+  edition
+  issue
+  number_of_volumes
+  pages
+  place
+  publication_title
+  publisher
+  running_time
+  series
+  series_number
+  studio
+  title
+  university
+  url
+  volume
+  website_title
+)
+
+class Zotero::Entities::Entry
+  attr_reader :creators, :kind, *ENTRY_ATTS
+
+  def initialize(data)
+    @key = data['key']  
+    @kind = data['data']['itemType'].underscore
+    @creators = generate_creators data['data']['creators']
+
+    ENTRY_ATTS.each do |att|
+      instance_variable_set "@#{att}", data['data'][att.camelize(:lower)]
+    end
+  end
+
+  def authors 
+    creators.select &:author?
+  end
+
+  def editors 
+    creators.select &:editor?
+  end
+
+  def translators
+    creators.select &:translator?
+  end
+
+  def creator_sort_string 
+    @creator_sort_string ||= generate_creator_sort_string
+  end
+
+  def to_h
+    ((ENTRY_ATTS + [:kind]).collect {|att|
+      [att, send(att.to_sym)]
+    } + [[:creators, creators.collect(&:to_h)]]).to_h.symbolize_keys
+  end
+
+  private
+
+  def generate_creators(data)
+    return [] unless data
+
+    data.collect do |creator_data| 
+      ::Zotero::Entities::Creator.new creator_data
+    end
+  end
+
+  def generate_creator_sort_string
+    creators.collect {|creator|
+      "#{creator.last_name} #{creator.first_name}"
+    }.join(' ')
+  end
+end

data/lib/zotero/library.rb

@@ -0,0 +1,19 @@
+class Zotero::Library 
+  attr_reader :collections
+
+  def initialize(user_id, key)
+    @api = ::Zotero::Api.new(user_id, key)
+  end
+
+  def collections
+    @collections ||= get_collections
+  end
+
+  private 
+
+  def get_collections
+    @api.get('/collections/top').collect do |data|
+      ::Zotero::Entities::Collection.new @api, data
+    end
+  end
+end

data/lib/zotero/version.rb

@@ -0,0 +1,3 @@
+module Zotero
+  VERSION = "0.2.1"
+end

data/zotero.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'zotero/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'zotero'
+  spec.version       = Zotero::VERSION
+  spec.authors       = ['Joshua Mostafa']
+  spec.email         = ['micapam@gmail.com']
+
+  spec.summary       = 'Access reference lists from Zotero with Ruby'
+  spec.description   = 'Provide easy Ruby access to Zotero, for e.g. generating online bibliographies and reading lists.'
+  spec.homepage      = 'https://github.com/micapam/zotero'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_dependency 'rest-client', '>= 2'
+  spec.add_dependency 'activesupport', '>= 4.2.7'
+  spec.add_dependency 'json', '>= 1'
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: zotero
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- Joshua Mostafa
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.7
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+description: Provide easy Ruby access to Zotero, for e.g. generating online bibliographies
+  and reading lists.
+email:
+- micapam@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/zotero.rb
+- lib/zotero/api.rb
+- lib/zotero/entities/collection.rb
+- lib/zotero/entities/creator.rb
+- lib/zotero/entities/entry.rb
+- lib/zotero/library.rb
+- lib/zotero/version.rb
+- zotero.gemspec
+homepage: https://github.com/micapam/zotero
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.1
+signing_key: 
+specification_version: 4
+summary: Access reference lists from Zotero with Ruby
+test_files: []