ferris_bueller 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 851cf963e02b7fb8b97ff936c02ccc157103dbdc
+  data.tar.gz: d48f31dbee5016c1911b2c33d92de564094850f4
+SHA512:
+  metadata.gz: c0bf0497e7272b7d9cc1c92cd94c4503a6497879d8fa0496d52394f7fe8957657c54273270da0f48d1f9376d668447a2dddf09d1bdda95de5bda8b587e8fc4c4
+  data.tar.gz: 5700e15dc9b4ee25ab8b16758e615b8a6df324cb86019d5c53840bae643849a98bc57219ffef774dc0c3337c57bb8da6448ee6a694fecfe8cee81dd98de64061

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+*.gem
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Goldstar
+
+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,79 @@
+# FerrisBueller
+
+FerrisBueller is a gem for creating events.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ferris_bueller'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ferris_bueller
+
+## Usage
+
+Creating an event:
+
+```
+client = FerrisBueller::Client.new(url: 'your-event-service.com', token: '1337807')
+
+client.create_event(
+  title: 'Jonan on Ice',
+  venue: {
+    name: 'Rose Garden',
+    locality: 'Portland',
+    region: 'Oregon'
+  },
+  shows: [
+    { date: '2015-03-01 19:00:00 -0700',
+      date_description: 'First Sunday of March',
+      time_description: "Seven o'clock at night" },
+    { date: '2015-03-08 19:00:00 -0700',
+      date_description: 'Second Sunday of March',
+      time_description: "Seven o'clock at night" },
+    { date: '2015-03-15 19:00:00 -0700',
+      date_description: 'Third Sunday of March',
+      time_description: "Seven o'clock at night" },
+    { date: '2015-03-22 19:00:00 -0700',
+      date_description: 'Third Sunday of March',
+      time_description: "Seven o'clock at night" },
+    { date: '2015-03-29 19:00:00 -0700',
+      date_description: 'Third Sunday of March',
+      time_description: "Seven o'clock at night" },
+  ],
+  source: "unique_name_for_your_event_source",
+  source_listing: {
+    title: 'Jonan on Ice',
+    where: 'The Rose Garden in Portland Oregon',
+    when: 'Every Sunday night in March at 7'
+  }
+)
+```
+
+The source_listing attribute is used to prevent insertion of duplicates and to maintain a
+canonical record of imported events. It should include all of the data you
+extracted from your source that consistently identifies this event.
+
+Do not include timestamps or other data from your source that is likely to change
+for the same event.
+
+If two events have identical source listings only the first one will be inserted.
+
+### Response
+
+FerrisBueller::Event.create will return a hash with the id of the event whether or not
+it was created by your call. It will also return a boolean value to indicate
+whether or not the data you submitted created that event.
+
+```
+FerrisBueller::Event.create(...)
+#=> { id: 7, created: false }
+```

data/Rakefile

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

data/ferris_bueller.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ferris_bueller/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ferris_bueller"
+  spec.version       = FerrisBueller::VERSION
+  spec.authors       = ["Jonan Scheffler"]
+  spec.email         = ["jonanscheffler@gmail.com"]
+  spec.summary       = %q{Events gem}
+  spec.description   = %q{A gem for creating events}
+  spec.homepage      = "https://github.com/1337807"
+  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_runtime_dependency "faraday", "~> 0.9.1"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'rspec', '~> 3.2', '>= 3.2.0'
+  spec.add_development_dependency "pry", "~> 0.10.1"
+end

data/lib/ferris_bueller/client.rb

@@ -0,0 +1,36 @@
+require 'faraday'
+
+module FerrisBueller
+  class Client
+    attr_reader :connection
+
+    def initialize(options = {})
+      @url = from_options(:url, options)
+      @token = from_options(:token, options)
+
+      @connection = Faraday.new(url: @url)
+      @connection.token_auth(@token)
+    end
+
+    def from_options(key, options)
+      if value = options[key]
+        value
+      else
+        raise ArgumentError.new "#{key.inspect} is required."
+      end
+    end
+
+    def create_event(event_attributes)
+      validate_event_attributes(event_attributes)
+      self.connection.post '/events', event_attributes
+    end
+
+    def validate_event_attributes(event_attributes)
+      raise ArgumentError.new ":event is required." unless event_attributes[:event]
+
+      [:title, :venue, :shows, :source_listing, :source].each do |key|
+        raise ArgumentError.new ":event => #{key.inspect} is required." unless event_attributes[:event][key]
+      end
+    end
+  end
+end

data/lib/ferris_bueller/version.rb

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

data/lib/ferris_bueller.rb

@@ -0,0 +1,5 @@
+require "ferris_bueller/version"
+require "ferris_bueller/client"
+
+module FerrisBueller
+end

data/spec/ferris_bueller/client_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+
+describe FerrisBueller::Client do
+  it "must be created with a URL" do
+    expect { FerrisBueller::Client.new }.to raise_error ArgumentError, ":url is required."
+  end
+
+  it "must be created with an authentication token" do
+    expect { FerrisBueller::Client.new(url: '') }.to raise_error ArgumentError, ":token is required."
+  end
+
+  it "sets the authorization header on the connection with the provided token" do
+    client = FerrisBueller::Client.new(url: '', token: '1337807')
+    expect(client.connection.headers['Authorization']).to eql("Token token=\"1337807\"")
+  end
+
+  context "#create_event" do
+    let(:client) { client = FerrisBueller::Client.new(url: 'fake_url', token: '1337807') }
+
+    it "POSTs the event data to the events endpoint" do
+      expect(client.connection).to receive(:post).with('/events', anything)
+
+      client.create_event(event_data)
+    end
+
+    it "POSTs the provided event data" do
+      expect(client.connection).to receive(:post).with(anything, event_data)
+
+      client.create_event(event_data)
+    end
+
+    it "raises an error when the event is missing from the event data" do
+      event = event_data
+
+      event.delete(:event)
+      allow(client.connection).to receive(:post)
+      expect { client.create_event(event) }.to raise_error ArgumentError, ":event is required."
+    end
+
+    it "raises an error if any of the event attributes are missing" do
+      allow(client.connection).to receive(:post)
+
+      event_data[:event].keys.each do |key|
+        key_event_data = event_data
+        key_event_data[:event].delete key
+
+        expect { client.create_event(key_event_data) }.to raise_error ArgumentError, ":event => #{key.inspect} is required."
+      end
+    end
+  end
+
+  def event_data
+    {
+      event: {
+        title: "bueller_test_title",
+        venue: {
+          name: "bueller_test_venue_name",
+          locality: "bueller_test_locality",
+          region: "bueller_test_region"
+        },
+        shows: [
+          {
+            date: Time.now.to_s,
+            date_description: "bueller_test_show_date_description",
+            time_description: "bueller_test_show_date_description"
+          }
+        ],
+        source_listing: {
+          title: "bueller_test_source_listing_title"
+        },
+        source: "csv_upload"
+      }
+    }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,94 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require 'ferris_bueller'
+
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: ferris_bueller
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jonan Scheffler
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-31 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.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+- !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.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+description: A gem for creating events
+email:
+- jonanscheffler@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ferris_bueller.gemspec
+- lib/ferris_bueller.rb
+- lib/ferris_bueller/client.rb
+- lib/ferris_bueller/version.rb
+- spec/ferris_bueller/client_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/1337807
+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: Events gem
+test_files:
+- spec/ferris_bueller/client_spec.rb
+- spec/spec_helper.rb
+has_rdoc: