url_2_event 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 827439573edb14f1cfbfd37bb83f4ad303b2fcb9
+  data.tar.gz: 7384b26ac0e9177fdaf1c7df5aa0feb580ff2eaf
+SHA512:
+  metadata.gz: b1b179fc628d6a4d0b987e336cf3372f16a035093117dcfaea14d26480149bfd6be0ad79bc64abe99cd1f1f089ab42be2a0b16f2053da92bec4fea71a7fa3744
+  data.tar.gz: 5ccc67d813ab1f5d6a54c020cfaa70ec088aafe02a6a787612c8532396ecfabf9a95e78cd08e294885edc3eb2ab3773bb5d7d2ab8a2c9190a023d194547edc6e

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,302 @@
+AllCops:
+  NoGoZone:
+    - db
+    - script
+
+# Use UTF-8 as the source file encoding.
+Encoding:
+  Enabled: false
+
+# Limit lines to 80 characters.
+LineLength:
+  Enabled: true
+  Max: 79
+
+# Avoid methods longer than 10 lines of code
+MethodLength:
+  Enabled: true
+  CountComments: false  # count full line comments?
+  Max: 65
+
+# No hard tabs.
+Tab:
+  Enabled: true
+
+# Avoid trailing whitespace.
+TrailingWhitespace:
+  Enabled: true
+
+# Indent when as deep as case.
+CaseIndentation:
+  Enabled: true
+
+# Use empty lines between defs.
+EmptyLineBetweenDefs:
+  Enabled: true
+
+# Don't use several empty lines in a row.
+EmptyLines:
+  Enabled: true
+
+# Use spaces around operators.
+SpaceAroundOperators:
+  Enabled: true
+
+# Use spaces around { and before }.
+SpaceAroundBraces:
+  Enabled: true
+
+# No spaces after ( or before ).
+SpaceInsideParens:
+  Enabled: true
+
+# No spaces after [ or before ].
+SpaceInsideBrackets:
+  Enabled: true
+
+# Use spaces after commas.
+SpaceAfterComma:
+  Enabled: true
+
+# Use spaces after semicolons.
+SpaceAfterSemicolon:
+  Enabled: true
+
+# Use spaces after colons.
+SpaceAfterColon:
+  Enabled: true
+
+# Prefer symbols instead of strings as hash keys.
+HashSyntax:
+  Enabled: true
+
+# Use Unix-style line endings.
+EndOfLine:
+  Enabled: true
+
+# Add underscores to large numeric literals to improve their readability.
+NumericLiterals:
+  Enabled: true
+
+# Align the parameters of a method call if they span more than one line.
+AlignParameters:
+  Enabled: true
+
+# Use def with parentheses when there are arguments.
+DefWithParentheses:
+  Enabled: true
+
+# Omit the parentheses when the method doesn't accept any arguments.
+DefWithoutParentheses:
+  Enabled: true
+
+# Never use if x; .... Use the ternary operator instead.
+IfWithSemicolon:
+  Enabled: true
+
+# Never use then for multi-line if/unless.
+MultilineIfThen:
+  Enabled: true
+
+# Favor the ternary operator(?:) over if/then/else/end constructs.
+OneLineConditional:
+  Enabled: true
+
+# Avoid using {...} for multi-line blocks (multiline chaining is always ugly).
+MultilineBlocks:
+  Enabled: true
+
+# Prefer {...} over do...end for single-line blocks.
+SingleLineBlocks:
+  Enabled: true
+
+# Avoid parameter lists longer than three or four parameters.
+ParameterLists:
+  Enabled: true
+
+# Prefer ' strings when you don't need string interpolation or special symbols.
+StringLiterals:
+  Enabled: false
+
+# Avoid multi-line ?: (the ternary operator); use if/unless instead.
+MultilineTernaryOperator:
+  Enabled: true
+
+# Use one expression per branch in a ternary operator.
+NestedTernaryOperator:
+  Enabled: true
+
+# Never use unless with else. Rewrite these with the positive case first.
+UnlessElse:
+  Enabled: true
+
+# Use &&/|| for boolean expressions, and/or for control flow.
+AmpersandsPipesVsAndOr:
+  Enabled: true
+
+# Use when x then ... for one-line cases.
+WhenThen:
+  Enabled: true
+
+# Favor modifier if/unless usage when you have a single-line body.
+IfUnlessModifier:
+  Enabled: true
+
+# Favor modifier while/until usage when you have a single-line body.
+WhileUntilModifier:
+  Enabled: true
+
+# Favor unless over if for negative conditions (or control flow or).
+FavorUnlessOverNegatedIf:
+  Enabled: true
+
+# Favor until over while for negative conditions.
+FavorUntilOverNegatedWhile:
+  Enabled: true
+
+# Use spaces around the = operator when assigning default values in def params.
+SpaceAroundEqualsInParameterDefault:
+  Enabled: true
+
+# Use the new lambda literal syntax.
+NewLambdaLiteral:
+  Enabled: true
+
+# Don't use parentheses around the condition of an if/unless/while.
+ParenthesesAroundCondition:
+  Enabled: true
+
+# Use snake_case for symbols, methods and variables.
+MethodAndVariableSnakeCase:
+  Enabled: true
+
+# Use CamelCase for classes and modules.
+ClassAndModuleCamelCase:
+  Enabled: true
+
+# Causes Ruby to check the syntax of the script and exit without executing.
+Syntax:
+  Enabled: true
+
+# Preferred collection methods.
+CollectionMethods:
+  Enabled: true
+
+# Prefer each over for.
+AvoidFor:
+  Enabled: true
+
+# Avoid Perl-style global variables.
+AvoidPerlisms:
+  Enabled: true
+
+# Avoid Perl-style regex back references.
+AvoidPerlBackrefs:
+  Enabled: true
+
+# Avoid the use of class variables.
+AvoidClassVars:
+  Enabled: true
+
+# Symbol literals should use snake_case.
+SymbolSnakeCase:
+  Enabled: true
+
+# Don't interpolate global, instance and class variables directly in strings.
+VariableInterpolation:
+  Enabled: true
+
+# Don't use semicolons to terminate expressions.
+Semicolon:
+  Enabled: true
+  # For example; def area(height, width); height * width end
+  AllowAfterParameterListInOneLineMethods: false
+  # For example; def area(height, width) height * width; end
+  AllowBeforeEndInOneLineMethods: true
+
+# Use sprintf instead of String#%.
+FavorSprintf:
+  Enabled: true
+
+# Use Array#join instead of Array#*.
+FavorJoin:
+  Enabled: true
+
+# Use alias_method instead of alias.
+Alias:
+  Enabled: true
+
+# Avoid using rescue in its modifier form.
+RescueModifier:
+  Enabled: true
+
+# Avoid the use of %q, %Q, %s and %x.
+PercentLiterals:
+  Enabled: false
+
+RegexpLiteral:
+  Enabled: false
+
+UnneededPercentQ:
+  Enabled: false
+
+# Prefer () as delimiters for all % literals.
+BraceAfterPercent:
+  Enabled: true
+
+# Never use return in an ensure block.
+EnsureReturn:
+  Enabled: true
+
+# Don't suppress exception.
+HandleExceptions:
+  Enabled: true
+
+# Use only ascii symbols in identifiers.
+AsciiIdentifiers:
+  Enabled: true
+
+# Use only ascii symbols in comments.
+AsciiComments:
+  Enabled: true
+
+# Do not use block comments.
+BlockComments:
+  Enabled: true
+
+# Avoid rescuing the Exception class.
+RescueException:
+  Enabled: true
+
+# Prefer array literal to Array.new.
+ArrayLiteral:
+  Enabled: true
+
+# Prefer hash {} literail to Hash.new.
+HashLiteral:
+  Enabled: true
+
+# When defining binary operators, name the argument other.
+OpMethod:
+  Enabled: true
+
+# Name reduce arguments |a, e| (accumulator, element)
+ReduceArguments:
+  Enabled: true
+
+# Use %r only for regular expressions matching more than one '/' character.
+PercentR:
+  Enabled: true
+
+# Use %r for regular expressions matching more than one '/' character.
+FavorPercentR:
+  Enabled: true
+
+# Use self when defining module/class methods.
+ClassMethods:
+  Enabled: true
+
+# Avoid single-line methods.
+SingleLineMethods:
+  Enabled: true
+  AllowIfMethodIsEmpty: true

data/CONTRIBUTING.md

@@ -0,0 +1,124 @@
+# Contributing Guidelines
+
+If you're thinking about contributing to this project, it's likely that you'll want to add support for parsing events from a currently unsupported website. The list of current adapters can be found in [`lib/url_2_events/adapters`](https://github.com/StartupWeekend/url_2_event/tree/master/lib/url_2_event/adapters).
+
+## Adding a new website adapter
+
+### Adapter class
+
+First, get to know how each adapter works. To get started, create a file in the adapters folder called `website_name.rb`, replacing `website_name` with the name of the website you're creating. Create a class under the module `Url2Event` and have the class inherit from `Base`.
+
+```ruby
+module Url2Event
+  class WebsiteName
+
+  end
+end
+```
+
+The major methods you'll need to implement are `to_event(response)`, `options`, `event_endpoint` and `self.is_parser_for?`. You'll also need to call `base_uri 'hostname'` in the class definition. Let's do this for an example website:
+
+```ruby
+module Url2Event
+  class WebsiteName
+    base_uri 'www.websitename.com'
+
+    # this method should return a boolean, indicating whether
+    # the `uri` given is supported by this adapter.
+    def self.is_parser_for?(uri)
+      !uri.hostname.match(%r{(?:www\.)?websitename\.com}).nil?
+    end
+
+    # return a hash, which will get passed to your http query.
+    # this hash will get passed to `HTTParty`'s `get` method.
+    def options
+      @options = {
+        query: {
+          my_name: "is_good"
+        }
+      }
+    end
+
+    # return a string indicating the path that to be appended
+    # to `base_uri` for this event. `@uri` is the URL that is passed
+    # to your adapter.
+    def event_endpoint
+      "/api/#{@uri.path.split('/').last}"
+    end
+
+    # return an `Event` model based on the HTTP response you get
+    # after hitting `event_endpoint`. Provide as many details as
+    # possible for this event.
+    def to_event(response)
+      Event.new({
+        title: response['title'],
+        begin_at: response['start_time'],
+        end_at: response['end_time'],
+        location: response['address'],
+        price: response['price'],
+        description: response['description']
+      })
+    end
+  end
+end
+```
+
+Great! You're done setting up your adapter's class, and you're ready to move on to testing. We require that all adapters are tested, otherwise you're contribution won't be accepted.
+
+### Adapter tests
+
+To get started, create a new file called `spec/website_name_spec.rb`. Follow [proper rspec patterns](http://betterspecs.org/) while writing tests, and refer to other tests for examples. The goal is to write tests that go through example scenarios and prove that your adapter works the way it should.
+
+To run tests, run `bundle exec guard` in the command line. As you write code, your tests will be run automatically.
+
+```ruby
+require 'spec_helper'
+
+describe Url2Event::WebsiteName do
+  let(:url) { URI.parse("http://www.websitename.com/events/187282242") }
+  describe ".is_parser_for?" do
+    it { expect(described_class.is_parser_for?(url)).to eql(true) }
+  end
+
+  # use `vcr` in any specs that use HTTP requests, otherwise your tests
+  # will fail.
+  describe "get_event", :vcr do
+    let(:begin_at) { Time.parse("2014-07-29 18:00:00 +0000") }
+    let(:end_at) { Time.parse("2014-07-29 21:00:00 +0000") }
+    let(:title) { "Startup Grind Seattle Hosts Robert Scoble, Tech Geek (Rackspace)" }
+    let(:parser) { described_class.new(url) }
+
+    subject { parser.get_event }
+
+    it { should be_instance_of(Event) }
+    its(:title) { should eql(title) }
+    its(:begin_at) { should eql(begin_at) }
+    its(:end_at) { should eql(end_at) }
+    its(:location) { should eql("Dice Cabana at SURF, 821 2nd Avenue #410, Seattle") }
+    its(:price) { should be_nil }
+
+    context "when the url is unparsable" do
+      let(:unparsable) { URI.parse("http://www.websitename.com/Startup-Grind-Seattle") }
+      let(:parser) { described_class.new(unparsable) }
+      subject { parser.get_event }
+      it { should raise_error(Url2Event::UnparsableSourceError) }
+    end
+  end
+end
+```
+
+This is just an example, and you think for yourself about how your tests should work, and what scenarios you should test. At the least, you should test that:
+
+- your adapter passes `self.is_adapter_for?` correctly
+- `get_event` works for valid URLs
+- `get_event` doesn't work for URLs that aren't parseable, like an 'about' page.
+
+Make sure all tests pass when you run `rspec`. It's also a good idea to look in `coverage/index.html` to make sure your entire adapter's code is tested. If everything looks good, follow our Git instructions to open a pull request!
+
+## Git Instructions
+
+1. Fork it ( https://github.com/startupweekend/url_2_event/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request