butterfli 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e7b692e5c348c92eaf1fae64a84cedd5de808121
+  data.tar.gz: e0b34c538cd18011042e6cbf0a38b30b09855147
+SHA512:
+  metadata.gz: cc7bcc3c5e460da640c6c0233fb0bed38c911222682f080de498bf5ef3f921ce2def330f3152fef65a583f8ad8e47c5b83a9367216d2f594e1f21a75921c8c7e
+  data.tar.gz: 146d25c23e15a486de99015a97faf9ae43c98164822f399985790d811422270a368e1e1bf192e5105a3918509b9118af7d87fdc8afef25a6e8b6229d8c5b5b3a

data/.gitignore

@@ -0,0 +1,34 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - ruby-head

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 David Elner
+
+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,25 @@
+Olfactory
+==========
+
+[![Build Status](https://travis-ci.org/delner/butterfli.svg?branch=master)](https://travis-ci.org/delner/butterfli) ![Gem Version](https://badge.fury.io/rb/butterfli.svg)
+###### *For Ruby 1.9.3, 2.0.0, 2.1.0*
+
+### Introduction
+
+`butterfli` is a gem that provides a common container for social media objects and other "stories" from around the web. It takes data (typically retrieved via API) and converts them into a Story object. 
+
+It is the base for its sister gem, `butterfli-rails` which adds API enpoints for public APIs via Rails engines.
+
+### Installation
+
+(To be written.)
+
+### Usage
+
+(To be written.)
+
+### Changelog
+
+#### Version 0.0.1
+
+ - Initial version of Butterfli (defines Story common container)

data/Rakefile

@@ -0,0 +1,30 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+task :default => :spec
+task :test => :spec
+
+namespace :doc do
+  begin
+    require 'yard'
+  rescue LoadError
+    # ignore
+  else
+    YARD::Rake::YardocTask.new do |task|
+      task.files   = ['lib/**/*.rb']
+      task.options = [
+        '--protected',
+        '--output-dir', 'doc/yard',
+        '--tag', 'format:Supported formats',
+        '--markup', 'markdown',
+      ]
+    end
+  end
+end
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -I lib -r butterfli.rb"
+end

data/butterfli.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+$LOAD_PATH << File.expand_path("../lib", __FILE__)
+require 'butterfli/version'
+
+Gem::Specification.new do |s|
+  s.name          = "butterfli"
+  s.version       = Butterfli::VERSION
+  s.authors       = ["David Elner"]
+  s.email         = ["david@davidelner.com"]
+  s.summary       = %q{Processes data from the web into a common container.}
+  s.description   = %q{Processes data from the web into a common container, typically from social media.}
+  s.homepage      = "http://github.com/delner/butterfli"
+  s.license       = "MIT"
+
+  s.files       = `git ls-files`.split("\n")
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files  = `git ls-files -- {spec,features,gemfiles}/*`.split("\n")
+
+  s.require_paths = ["lib"]
+  s.required_ruby_version = Gem::Requirement.new(">= 1.9.2")
+
+  # Future dependencies:
+  # s.add_dependency "instagram"
+  # s.add_dependency "httparty"
+
+  s.add_development_dependency "bundler", "~> 1.7"
+  s.add_development_dependency "rake", "~> 10.0"
+  s.add_development_dependency "rspec", "~> 3.3"
+  s.add_development_dependency "pry"
+  s.add_development_dependency("pry-stack_explorer", "~> 0.4.9")
+end

data/lib/butterfli.rb

@@ -0,0 +1,14 @@
+require "butterfli/version"
+
+require 'butterfli/story/schemable'
+require 'butterfli/story/authorable'
+require 'butterfli/story/taggable'
+require 'butterfli/story/likeable'
+require 'butterfli/story/commentable'
+require 'butterfli/story/shareable' 
+require 'butterfli/story/attributable'
+require 'butterfli/story/describable'
+require 'butterfli/story/imageable'
+require 'butterfli/story/mappable'
+require 'butterfli/story'
+

data/lib/butterfli/story.rb

@@ -0,0 +1,16 @@
+class Butterfli::Story < Hash
+  include Butterfli::Schemable
+  include Butterfli::Attributable
+  include Butterfli::Describable
+  include Butterfli::Authorable  # NEW
+  include Butterfli::Taggable  # NEW
+  include Butterfli::Commentable  # NEW
+  include Butterfli::Shareable  # NEW 
+  include Butterfli::Likeable # NEW
+  include Butterfli::Imageable
+  include Butterfli::Mappable
+
+  field :type # The kind of story (e.g. 'tweet', 'post', 'photo', 'video')
+  field :source # Name of the source it came from ('twitter', 'facebook')
+  field :date # Time the story occurred
+end

data/lib/butterfli/story/attributable.rb

@@ -0,0 +1,11 @@
+module Butterfli::Attributable
+  def self.included(base)
+    base.field :references, default: References.new
+  end
+
+  class References < Hash
+    include Butterfli::Schemable
+
+    field :source_uri # A URI to the original story
+  end
+end

data/lib/butterfli/story/authorable.rb

@@ -0,0 +1,12 @@
+module Butterfli::Authorable
+  def self.included(base)
+    base.field :author, default: Author.new
+  end
+
+  class Author < Hash
+    include Butterfli::Schemable
+
+    field :username # The author's username
+    field :name # The author's real name
+  end
+end

data/lib/butterfli/story/commentable.rb

@@ -0,0 +1,18 @@
+module Butterfli::Commentable
+  def self.included(base)
+    base.array :comments, default: Comments.new
+  end
+
+  class Comments < Array
+    include Butterfli::Schemable
+
+    item :comment
+  end
+  class Comment < Hash
+    include Butterfli::Schemable
+    include Butterfli::Authorable
+    include Butterfli::Likeable
+
+    field :body
+  end
+end

data/lib/butterfli/story/describable.rb

@@ -0,0 +1,12 @@
+module Butterfli::Describable
+  def self.included(base)
+    base.field :text, default: Text.new
+  end
+
+  class Text < Hash
+    include Butterfli::Schemable
+
+    field :title # A short title describing the story
+    field :body # The story content
+  end
+end

data/lib/butterfli/story/imageable.rb

@@ -0,0 +1,19 @@
+module Butterfli::Imageable
+  def self.included(base)
+    base.field :images, default: Images.new
+  end
+
+  class Images < Hash
+    include Butterfli::Schemable
+
+    array :thumbnails # A URI to the original story
+  end
+
+  class Image < Hash
+    include Butterfli::Schemable
+
+    field :uri
+    field :height
+    field :width
+  end
+end

data/lib/butterfli/story/likeable.rb

@@ -0,0 +1,15 @@
+module Butterfli::Likeable
+  def self.included(base)
+    base.array :likes, default: Likes.new
+  end
+
+  class Likes < Array
+    include Butterfli::Schemable
+
+    item :like
+  end
+  class Like < Hash
+    include Butterfli::Schemable
+    include Butterfli::Authorable
+  end
+end

data/lib/butterfli/story/mappable.rb

@@ -0,0 +1,12 @@
+module Butterfli::Mappable
+  def self.included(base)
+    base.field :location, default: Location.new
+  end
+
+  class Location < Hash
+    include Butterfli::Schemable
+
+    field :lat # The latitude of where the story took place
+    field :lng # The longitude of where the story took place
+  end
+end

data/lib/butterfli/story/schemable.rb

@@ -0,0 +1,64 @@
+module Butterfli::Schemable
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+  
+  module ClassMethods
+    def schema
+      (@schema ||= {})
+    end
+
+    # Adds a field to the schema and defines getter/setters
+    def field(name, options = {})
+      self.define_field(:field, name, options)
+    end
+
+    def item(name, options = {})
+      self.schema[name.to_sym] = { field_type: :item }.merge(options)
+      # We don't need to define helper methods here...
+    end
+
+    def array(name, options = {})
+      self.define_field(:array, name, options)
+    end
+
+    protected
+    def define_field(field_type, name, options = {})
+      self.schema[name.to_sym] = { field_type: field_type }.merge(options)
+      self.send :define_method, name do
+        self[name]
+      end
+      self.send :define_method, "#{name}=" do |value|
+        self[name] = value
+      end
+    end
+  end
+
+  def initialize
+    initialize_with_defaults
+  end
+
+  def initialize_with_defaults
+    self.class.schema.each do |name, attributes|
+      if self.class <= Hash
+        if attributes[:field_type] == :array
+          if attributes[:default].nil?
+            default_value = []
+          else
+            default_value = attributes[:default].clone
+          end
+        else
+          # This sort of sucks, but we can't tell what's cloneable...
+          begin
+            default_value = attributes[:default] && attributes[:default].clone
+          rescue
+            default_value = attributes[:default]
+          end
+        end
+
+        # Set default value for field
+        self[name] = default_value
+      end
+    end
+  end
+end

data/lib/butterfli/story/shareable.rb

@@ -0,0 +1,15 @@
+module Butterfli::Shareable
+  def self.included(base)
+    base.array :shares, default: Shares.new
+  end
+
+  class Shares < Array
+    include Butterfli::Schemable
+
+    item :share
+  end
+  class Share < Hash
+    include Butterfli::Schemable
+    include Butterfli::Authorable
+  end
+end

data/lib/butterfli/story/taggable.rb

@@ -0,0 +1,5 @@
+module Butterfli::Taggable
+  def self.included(base)
+    base.array :tags
+  end
+end

data/lib/butterfli/version.rb

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

data/spec/butterfli/buttefli_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe Butterfli do
+  # TODO: Add examples
+end

data/spec/butterfli/story/attributable_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+shared_examples "attributable" do
+  describe "#references" do
+    it_behaves_like "it has a field", "references"
+
+    context do
+      subject { super().references }
+      it_behaves_like "it has a field", "source_uri"
+    end
+  end
+end

data/spec/butterfli/story/authorable_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+shared_examples "authorable" do
+  describe "#author" do
+    it_behaves_like "it has a field", "author"
+
+    context do
+      subject { super().author }
+      it_behaves_like "it has a field", "username"
+      it_behaves_like "it has a field", "name"
+    end
+  end
+end

data/spec/butterfli/story/commentable_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+shared_examples "commentable" do
+  describe "#comments" do
+    it_behaves_like "it has a field", "comments"
+  end
+
+  # TODO: Add coverage for Comment
+end

data/spec/butterfli/story/describable_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+shared_examples "describable" do
+  describe "#text" do
+    it_behaves_like "it has a field", "text"
+  end
+
+  context do
+    subject { super().text }
+    it_behaves_like "it has a field", "title"
+    it_behaves_like "it has a field", "body"
+  end
+end

data/spec/butterfli/story/imageable_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+shared_examples "imageable" do
+  describe "#images" do
+    it_behaves_like "it has a field", "images"
+  end
+
+  context do
+    subject { super().images }
+    it_behaves_like "it has a field", "thumbnails"
+  end
+
+  # TODO: Add coverage for Image
+end

data/spec/butterfli/story/likeable_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+shared_examples "likeable" do
+  describe "#likes" do
+    it_behaves_like "it has a field", "likes"
+  end
+
+  # TODO: Add coverage for Like
+end

data/spec/butterfli/story/mappable_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+shared_examples "mappable" do
+  describe "#location" do
+    it_behaves_like "it has a field", "location"
+  end
+
+  context do
+    subject { super().location }
+    it_behaves_like "it has a field", "lat"
+    it_behaves_like "it has a field", "lng"
+  end
+end

data/spec/butterfli/story/schemable_spec.rb

@@ -0,0 +1,101 @@
+require 'spec_helper'
+
+describe Butterfli::Schemable do
+  describe "#schema" do
+    subject { schemable_class.schema }
+    context "with no fields defined" do
+      let(:schemable_class) do
+        stub_const 'Widget', Class.new(Hash)
+        Widget.class_eval { include Butterfli::Schemable }
+        Widget
+      end
+      it { expect(subject).to be_a(Hash) }
+    end
+    context "with fields defined" do
+      let(:schemable_class) do
+        stub_const 'Widget', Class.new(Hash)
+        Widget.class_eval do
+          include Butterfli::Schemable
+          field :gizmo
+        end
+        Widget
+      end
+      it do
+        expect(subject).to be_a(Hash)
+        expect(subject).to include(:gizmo)
+      end
+    end
+  end
+  describe "#field" do
+    subject { schemable_class.new }
+    context "with no default" do
+      let(:schemable_class) do
+        stub_const 'Widget', Class.new(Hash)
+        Widget.class_eval do
+          include Butterfli::Schemable
+          field :gizmo
+        end
+        Widget
+      end
+      it { expect(subject).to include(gizmo: nil) }
+    end
+    
+    context "with a default" do
+      context "that isn't cloneable" do
+        [nil, false, true, 1, -2.15].each do |default_value|
+          let(:schemable_class) do
+            stub_const 'Widget', Class.new(Hash)
+            Widget.class_eval { include Butterfli::Schemable }
+            Widget
+          end
+          it do
+            schemable_class.class_eval { field :gizmo, default: default_value }
+            expect(subject).to include(gizmo: default_value)
+            expect(subject[:gizmo].object_id).to eq(default_value.object_id)
+          end
+        end
+      end
+      context "that is cloneable" do
+        # Because let blocks and class evals are stupid
+        default_value = "default" 
+
+        let(:schemable_class) do
+          stub_const 'Widget', Class.new(Hash)
+          Widget.class_eval do
+            include Butterfli::Schemable
+            field :gizmo, default: default_value
+          end
+          Widget
+        end
+        it do
+          expect(subject).to include(gizmo: default_value)
+          expect(subject[:gizmo].object_id).not_to be(default_value.object_id)
+        end
+      end
+    end
+  end
+end
+
+shared_examples "schemable" do
+  describe "#schema" do
+    subject { base_class.schema }
+    it { expect(base_class).to respond_to(:schema) }
+  end
+  describe "#field" do
+    subject { base_class.field }
+    it { expect(base_class).to respond_to(:field) }
+  end
+  describe "#array" do
+    subject { base_class.array }
+    it { expect(base_class).to respond_to(:array) }
+  end
+  describe "#item" do
+    subject { base_class.item }
+    it { expect(base_class).to respond_to(:item) }
+  end
+end
+
+shared_examples "it has a field" do |name|
+  it { expect(subject).to respond_to(name) }
+  it { expect(subject).to respond_to("#{name}=") }
+end

data/spec/butterfli/story/shareable_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+shared_examples "shareable" do
+  describe "#shares" do
+    it_behaves_like "it has a field", "shares"
+  end
+
+  # TODO: Add coverage for Share
+end

data/spec/butterfli/story/taggable_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+shared_examples "taggable" do
+  describe "#tags" do
+    it_behaves_like "it has a field", "tags"
+  end
+end

data/spec/butterfli/story_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Butterfli::Story do
+  let(:base_class) { Butterfli::Story }
+  it_behaves_like "schemable"
+
+  context "instance" do
+    subject { base_class.new }
+    it_behaves_like "authorable"
+    it_behaves_like "attributable"
+    it_behaves_like "commentable"
+    it_behaves_like "describable"
+    it_behaves_like "imageable"
+    it_behaves_like "likeable"
+    it_behaves_like "mappable"
+    it_behaves_like "shareable"
+    it_behaves_like "taggable"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+
+$LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
+$LOAD_PATH << File.join(File.dirname(__FILE__))
+
+require 'rubygems'
+require 'pry'
+
+require 'butterfli'
+
+Dir["spec/support/**/*.rb"].each { |f| require File.expand_path(f) }
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: butterfli
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- David Elner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-27 00:00:00.000000000 Z
+dependencies:
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: pry-stack_explorer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.9
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.9
+description: Processes data from the web into a common container, typically from social
+  media.
+email:
+- david@davidelner.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- butterfli.gemspec
+- lib/butterfli.rb
+- lib/butterfli/story.rb
+- lib/butterfli/story/attributable.rb
+- lib/butterfli/story/authorable.rb
+- lib/butterfli/story/commentable.rb
+- lib/butterfli/story/describable.rb
+- lib/butterfli/story/imageable.rb
+- lib/butterfli/story/likeable.rb
+- lib/butterfli/story/mappable.rb
+- lib/butterfli/story/schemable.rb
+- lib/butterfli/story/shareable.rb
+- lib/butterfli/story/taggable.rb
+- lib/butterfli/version.rb
+- spec/butterfli/buttefli_spec.rb
+- spec/butterfli/story/attributable_spec.rb
+- spec/butterfli/story/authorable_spec.rb
+- spec/butterfli/story/commentable_spec.rb
+- spec/butterfli/story/describable_spec.rb
+- spec/butterfli/story/imageable_spec.rb
+- spec/butterfli/story/likeable_spec.rb
+- spec/butterfli/story/mappable_spec.rb
+- spec/butterfli/story/schemable_spec.rb
+- spec/butterfli/story/shareable_spec.rb
+- spec/butterfli/story/taggable_spec.rb
+- spec/butterfli/story_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/delner/butterfli
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: Processes data from the web into a common container.
+test_files: []
+has_rdoc: