notebook 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b3b29fcabdf77d11419e6d32a2de2d043a477dee
+  data.tar.gz: b858be60c3f58783f527a18f97505cd316406445
+SHA512:
+  metadata.gz: 245f639d4f1a9e72c6b1f91a7b62424ba54d3b68103bbe042ae675bc8dc0e53c7415ebdfb80973435a9863a9fd45cd1acda8c05a000a31e53823e571d32dfe07
+  data.tar.gz: 4b2dacc69de34a410005c9ce54a9636e1f964581154aa193ba2c17cedbfbdbe661af8efd48309807053259570baf787b6908dd253f16ed5d915bf26e0bd7df8b

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/fixtures/public/
+/spec/rails/db/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rubocop.yml

@@ -0,0 +1 @@
+inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,10 @@
+Style/Documentation:
+  Enabled: false
+Style/DoubleNegation:
+  Enabled: false
+Style/LineLength:
+  Max: 110
+Style/MethodLength:
+  Max: 15
+Style/SymbolProc:
+  Enabled: false

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Jon Moss
+
+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,109 @@
+# Notebook
+
+[![Build Status](https://travis-ci.org/moss-rb/notebook.svg?branch=master)](https://travis-ci.org/moss-rb/notebook?branch=master)
+
+Notebook is a Ruby file attachment library, that has easy integration
+with Rails and ActiveRecord.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'notebook'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install notebook
+
+## Rails Quickstart
+
+### Models
+
+**Rails 4**
+
+```ruby
+class User < ActiveRecord::Base
+  notebook_attachment :profile_picture
+end
+```
+
+### Edit and New Views
+
+```erb
+<%= form_for @user, url: users_path, html: { multipart: true } do |form| %>
+  <%= form.file_field :avatar %>
+<% end %>
+```
+
+### Controller
+
+**Rails 4**
+
+```ruby
+def create
+  @user = User.create(user_params)
+end
+
+private
+def user_params
+  params.require(:user).permit(:avatar)
+end
+```
+
+### Show View
+
+```erb
+<%= image_tag @user.avatar.url %>
+```
+
+### Deleting an Attachment
+
+Set the attribute to `nil` and save.
+
+```ruby
+@user.avatar = nil
+@user.save
+```
+
+### Configuration
+To use a different storage location than /public, create a
+`config/initializers/notebook.rb`, and then set the following:
+
+```ruby
+Notebook.public_directory = 'hi'
+```
+
+## Plain Old Ruby
+
+It's awesome you want to use plain Ruby without Rails with Notebook!
+
+First off, you need to read in a file, and create a new
+`Notebook::Attachment` object, like so:
+
+```ruby
+file = File.read("avatar.jpg")
+attachment = Notebook::Attachment.new(file)
+```
+
+The last and final step is to just upload it!
+```ruby
+attachment.upload
+
+# get the url of the newly persisted file
+attachment.url
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/moss-rb/notebook. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## 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,13 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+
+# RSpec Rake Task
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+# Rubocop Rake Task
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+
+task default: [:rubocop, :spec]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'notebook'
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/notebook/attachment.rb

@@ -0,0 +1,27 @@
+module Notebook
+  class Attachment
+    attr_reader :file
+
+    def initialize(file)
+      @file = file
+    end
+
+    def delete
+      adapter.delete
+    end
+
+    def upload
+      adapter.upload
+    end
+
+    def url
+      adapter.url
+    end
+
+    private
+
+    def adapter
+      StorageAdapters::Filesystem.new(self)
+    end
+  end
+end

data/lib/notebook/rails/active_record.rb

@@ -0,0 +1,28 @@
+require 'active_record'
+
+module Notebook
+  module ActiveRecordAttachment
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      # Attachment method which hooks into ActiveRecord models
+      def notebook_attachment(name)
+        define_method "#{name}" do
+          @notebook_attachment
+        end
+
+        define_method "#{name}=" do |value|
+          @notebook_attachment = Notebook::Attachment.new(value)
+          @notebook_attachment.upload
+          @notebook_attachment
+        end
+
+        after_destroy do
+          @notebook_attachment.delete
+        end
+      end
+    end
+  end
+end
+
+::ActiveRecord::Base.send(:include, Notebook::ActiveRecordAttachment)

data/lib/notebook/rails/engine.rb

@@ -0,0 +1,9 @@
+module Notebook
+  class Engine < ::Rails::Engine
+    initializer 'notebook.setup' do
+      ActiveSupport.on_load :active_record do
+        require 'notebook/rails/active_record'
+      end
+    end
+  end
+end

data/lib/notebook/storage_adapters/base.rb

@@ -0,0 +1,34 @@
+module Notebook
+  module StorageAdapters
+    class Base
+      def initialize(attachment, _options = {})
+        @attachment = attachment
+      end
+
+      def delete
+        fail(
+          NotImplementedError,
+          'Compliant Notebook storage adapters should define the `delete` method'
+        )
+      end
+
+      def get
+        fail(
+          NotImplementedError,
+          'Compliant Notebook storage adapters should define the `get` method'
+        )
+      end
+
+      def upload
+        fail(
+          NotImplementedError,
+          'Compliant Notebook storage adapters should define the `upload` method'
+        )
+      end
+
+      protected
+
+      attr_reader :attachment
+    end
+  end
+end

data/lib/notebook/storage_adapters/filesystem.rb

@@ -0,0 +1,25 @@
+require 'fileutils'
+
+module Notebook
+  module StorageAdapters
+    class Filesystem < Base
+      def initialize(attachment, options = {})
+        super
+        @storage_directory = options.fetch('storage_directory', Notebook.public_directory)
+      end
+
+      def delete
+        !!FileUtils.remove(url)
+      end
+
+      def upload
+        # When this command is successful, it returns nil
+        FileUtils.copy(attachment.file, @storage_directory).nil?
+      end
+
+      def url
+        (@storage_directory + File.basename(attachment.file)).to_s
+      end
+    end
+  end
+end

data/lib/notebook/storage_adapters.rb

@@ -0,0 +1,6 @@
+module Notebook
+  module StorageAdapters
+    autoload :Base, 'notebook/storage_adapters/base'
+    autoload :Filesystem, 'notebook/storage_adapters/filesystem'
+  end
+end

data/lib/notebook/version.rb

@@ -0,0 +1,3 @@
+module Notebook
+  VERSION = '0.1.0'
+end

data/lib/notebook.rb

@@ -0,0 +1,19 @@
+require 'pathname'
+require 'notebook/version'
+
+require 'notebook/rails/engine' if defined?(Rails)
+
+module Notebook
+  autoload :Attachment, 'notebook/attachment'
+  autoload :StorageAdapters, 'notebook/storage_adapters'
+
+  # Return the current filesystem storage directory in use
+  def self.public_directory
+    @public_directory || (Pathname.pwd + 'public')
+  end
+
+  # Set the  storage filesystem directory to use
+  def self.public_directory=(directory)
+    @public_directory = directory
+  end
+end

data/notebook.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'notebook/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'notebook'
+  spec.version       = Notebook::VERSION
+  spec.authors       = 'Jon Moss'
+  spec.email         = 'me@jonathanmoss.me'
+
+  spec.summary       = 'A simple Ruby file uploader library'
+  spec.description   = 'A simple Ruby file uploader library'
+  spec.homepage      = 'https://github.com/moss-rb/notebook'
+  spec.license       = 'MIT'
+
+  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.10'
+  spec.add_development_dependency 'rails'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'sqlite3'
+end

data/roadmap.txt

@@ -0,0 +1,6 @@
+* Global gem configuration
+  * filesystem --> storage_directory in FilesystemAdapter should be configurable (now it's hardwired to write in spec/fixtures)
+* Rails helpers
+  * `before_upload` and `after_upload`
+* S3 StorageAdapter
+  * refactor tests per Tute

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: notebook
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jon Moss
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rails
+  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
+    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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: sqlite3
+  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'
+description: A simple Ruby file uploader library
+email: me@jonathanmoss.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/notebook.rb
+- lib/notebook/attachment.rb
+- lib/notebook/rails/active_record.rb
+- lib/notebook/rails/engine.rb
+- lib/notebook/storage_adapters.rb
+- lib/notebook/storage_adapters/base.rb
+- lib/notebook/storage_adapters/filesystem.rb
+- lib/notebook/version.rb
+- notebook.gemspec
+- roadmap.txt
+homepage: https://github.com/moss-rb/notebook
+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.8
+signing_key: 
+specification_version: 4
+summary: A simple Ruby file uploader library
+test_files: []