RailsRunSignUp 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    M2YwOTdmNzQxNGFmOWJiZjJjYmNkNGU5MTM3MmMyOWQ0NmQ2OTVhMw==
+  data.tar.gz: !binary |-
+    OWY2ODFkNDE5MzE4MDRjYTNhZTE3MjI4N2YxNmI2MDdmN2ZlMWNjYQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    OGYyNWE2MGIxOTEyNmFkYjVlNWJiODRkN2YwZGFlOTgzNzUwYjFjNTEwMmM0
+    MTM5NGE5MzAzMDU0YWQ0MDgwM2YxNDI4MjY1ZmJjNWQ5MWM0OGIzYjA5YjM3
+    ZjNkMGYzNTBkNDM2N2JhNDA0ZWI4NWJlNDk2MDUyNWZlNzViNzM=
+  data.tar.gz: !binary |-
+    YWMzNGM0OTg5ZTRkNmJiMzQ1YTVlZTFiNmFmZjQ5ZWRiNDgxOTBhM2I0NzE5
+    YTEzNDUwZGY3ZmYyYzI2YzM2MzU2OGE5N2RjY2U3NDY2YzA4NTJhZDM0Njg4
+    MmM5OGMzNTZhNzM3NDk5M2UwN2IyMTQ4NzA3MDFkZjRjMjI2NTE=

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 David Slone
+
+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,29 @@
+# RailsRunSignUp
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'RailsRunSignUp'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install RailsRunSignUp
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/RailsRunSignUp.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'RailsRunSignUp/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "RailsRunSignUp"
+  spec.version       = RailsRunSignUp::VERSION
+  spec.authors       = ["David Slone"]
+  spec.email         = ["dbslone@gmail.com"]
+  spec.description   = %q{Retrieve races from RunSignUp}
+  spec.summary       = %q{This is a gem to allow an authenticated user to get races/race info from RunSignUp}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/Rakefile

@@ -0,0 +1,4 @@
+require "bundler/gem_tasks"
+require "net/http"
+require "uri"
+require "json"

data/lib/RailsRunSignUp.rb

@@ -0,0 +1,12 @@
+require "RailsRunSignUp/version"
+require "RailsRunSignUp/session"
+require "RailsRunSignUp/exceptions"
+require "RailsRunSignUp/record"
+require "RailsRunSignUp/model/race"
+require "RailsRunSignUp/model/event"
+require "RailsRunSignUp/model/registration_period"
+require "RailsRunSignUp/races"
+
+module RailsRunSignUp
+  # Your code goes here...
+end

data/lib/RailsRunSignUp/exceptions.rb

@@ -0,0 +1,17 @@
+# @author Khang Le
+
+module RailsRunSignUp
+  
+  class RailsRunSignUpError < StandardError
+  end
+  
+  class SessionError < StandardError
+  end
+  
+  class RaceError < StandardError
+  end
+  
+  class EventError < StandardError
+  end
+  
+end

data/lib/RailsRunSignUp/model/event.rb

@@ -0,0 +1,35 @@
+module RailsRunSignUp
+  class Model
+    class Event < RailsRunSignUp::Record
+      # event id
+      attr_reader :id
+      # event name (usually the same as race name)
+      attr_reader :name
+      # event details
+      attr_reader :details
+      # event start time
+      attr_reader :start_time
+      # event time when registration begins
+      attr_reader :registration_opens
+      # event type
+      attr_reader :event_type
+      # event distance of race
+      attr_reader :distance
+      # if event has volunteers
+      attr_reader :volunteer
+      # if event requires date of birth (for registration)
+      attr_reader :require_dob
+      # if event requires phone number (for registration)
+      attr_reader :require_phone
+      # what event gives away (T-Shirts etc.)
+      attr_reader :give_away
+      # event registration periods (multiple for different price ranges)
+      attr_accessor :registration_periods
+      
+      def add_registration_period period
+        self.registration_periods = []  if self.registration_periods.nil? 
+        self.registration_periods << period unless period.nil?
+      end
+    end
+  end
+end

data/lib/RailsRunSignUp/model/race.rb

@@ -0,0 +1,80 @@
+module RailsRunSignUp
+  class Model
+    class Race < RailsRunSignUp::Record
+      # race id
+      attr_reader :id
+      # name of race
+      attr_reader :name
+      # description
+      attr_reader :description
+      # runsignup url for race
+      attr_reader :url
+      # next date race takes place
+      attr_reader :next_date
+      # last date race took place
+      attr_reader :last_date
+      # (BOOL) if registration is open
+      attr_reader :is_registration_open
+      # if is a draft race
+      attr_reader :is_draft_race
+      # street of race
+      attr_reader :street
+      # city of race
+      attr_reader :city
+      # state of race
+      attr_reader :state
+      # zip code of race
+      attr_reader :zip_code
+      # country of race
+      attr_reader :country_code
+      # list of events of races
+      attr_accessor :events
+      # access token for oauth
+      attr_accessor :access_token
+      # api_key
+      attr :api_key
+      # api_secret
+      attr :api_secret
+      
+      # Retrieve all events for a race
+      #
+      # @author Khang Le
+      def get_events
+        response = self.access_token.get("/rest/race/#{self.id}/?format=json&race_id=#{self.id}&api_key=#{self.api_key}&api_secret=#{self.api_secret}")
+        json_response = JSON.parse(response.body)
+        
+				raise RailsRunSignUp::RaceError, "RailsRunSignUp race.get Error: #{json_response['error']['error_code']} - #{json_response['error']['error_msg']}" unless json_response['error'].nil?
+        
+        json_response['race']['events'].each do |event|
+          _event = RailsRunSignUp::Model::Event.new(
+            :id => event['id'],
+            :name => event['name'],
+            :details => event['details'],
+            :start_time =>  event['start_time'],
+            :registration_opens => event['registration_opens'],
+            :event_type => event['event_type'],
+            :distance => event['distance'],
+            :volunteer => event['volunteer'],
+            :require_dob => event['require_dob'],
+            :require_phone => event['require_phone'],
+            :give_away => event['give_away']
+          )
+          event['registration_periods'].each do |period|
+            _period = RailsRunSignUp::Model::RegistrationPeriod.new(
+              :registration_opens => period['registration_opens'],
+              :registration_closes => period['registration_closes'],
+              :race_fee => period['race_fee']
+            )
+            _event.add_registration_period _period
+          end
+          self.add_event _event
+        end
+      end
+      
+      def add_event event
+        self.events = [] if self.events.nil?
+        self.events << event
+      end
+    end
+  end
+end

data/lib/RailsRunSignUp/model/registration_period.rb

@@ -0,0 +1,12 @@
+module RailsRunSignUp
+  class Model
+    class RegistrationPeriod < RailsRunSignUp::Record
+      # time when registration period opens
+      attr_reader :registration_opens
+      # time when registration period closes
+      attr_reader :registration_closes
+      # race fee for registration period
+      attr_reader :race_fee
+    end
+  end
+end

data/lib/RailsRunSignUp/races.rb

@@ -0,0 +1,99 @@
+# @author Khang Le
+
+module RailsRunSignUp
+  
+  class Races
+    attr_accessor :races
+    
+    def initialize session
+      raise RailsRunSignUp::SessionError, "Invalid session (session cannot be nil)" if session.nil?
+      
+      @races = []
+      @access_token = session.access_token
+      @api_key = session.api_key
+      @api_secret = session.api_secret
+    end
+    
+    # get races from runsignup
+    #
+    # @author Khang Le
+    # param[aflt_token] T/F appends affiliate token to end of string, default T
+    # param[events] T/F shows events with each race, default F
+    # param[race_headings] T/F shows heading with each race, default F
+    # param[race_links] T/F shows links of each race, default F
+    # param[page] int specifies which page to return, default 1
+    # param[results_per_page] int specifies how many results to return per page, default 10
+    # param[sort] specifies how to sort results (name or date, descending or ascending), default name+ASC
+    # param[name] search race by name
+    # see runsignup api documentation for extra parameters
+    def get_races opts = {}
+      response = @access_token.get("/rest/races/?format=json&api_key=#{@api_key}&api_secret=#{@api_secret}&#{opts.map{|k, v| "#{k}=#{v}"}.join('&')}")
+      json_response = JSON.parse(response.body)
+      
+      raise RailsRunSignUp::RaceError, "RunSignUp races.get Error: #{json_response['error']['error_code']} - #{json_response['error']['error_msg']}" unless json_response['error'].nil?
+
+      self.races = parse_json json_response, opts unless json_response.nil?
+      self.races
+    end
+    
+    def parse_json json_response, opts
+      races = []
+      count = 0
+      
+      return if json_response['races'].nil?
+      
+      json_response['races'].each do |race|
+        _race = RailsRunSignUp::Model::Race.new(
+          :access_token => @access_token,
+          :api_key => @api_key,
+          :api_secret => @api_secret,
+      	  :id => race['race']['race_id'],
+          :name => race['race']['name'],
+          :description => race['race']['description'],
+          :url => race['race']['url'],
+          :next_date => race['race']['next_date'],
+          :last_date => race['race']['last_date'],
+          :is_registration_open => race['race']['is_registration_open'],
+          :is_draft_race => race['race']['is_draft_race'],
+          :street => race['race']['address']['street'],
+          :city => race['race']['address']['city'],
+          :state => race['race']['address']['state'],
+          :zip_code => race['race']['address']['zip_code'],
+          :country_code => race['race']['address']['country_code']
+      	)
+        
+        if !opts[:events].nil? && opts[:events] === "T"
+          race['race']['events'].each do |event|
+            _event = RailsRunSignUp::Model::Event.new(
+              :id => event['id'],
+              :name => event['name'],
+              :details => event['details'],
+              :start_time =>  event['start_time'],
+              :registration_opens => event['registration_opens'],
+              :event_type => event['event_type'],
+              :distance => event['distance'],
+              :volunteer => event['volunteer'],
+              :require_dob => event['require_dob'],
+              :require_phone => event['require_phone'],
+              :give_away => event['give_away']
+            )
+          
+            event['registration_periods'].each do |period|
+              _period = RailsRunSignUp::Model::RegistrationPeriod.new(
+                :registration_opens => period['registration_opens'],
+                :registration_closes => period['registration_closes'],
+                :race_fee => period['race_fee']
+              )
+              _event.add_registration_period _period
+            end
+            _race.add_event _event 
+          end
+        end
+      	races << _race
+      	count = count + 1
+      	break if !opts[:limit].nil? && count >= opts[:limit].to_i
+      end
+      races
+    end
+  end
+end

data/lib/RailsRunSignUp/record.rb

@@ -0,0 +1,14 @@
+# @author Khang Le
+
+module RailsRunSignUp
+  class Record
+    def initialize (params)
+      return if params.nil?
+      
+      params.each do |key, value|
+        name = key.to_s
+				instance_variable_set("@#{name}", value) if respond_to?(name)
+      end
+    end
+  end
+end

data/lib/RailsRunSignUp/session.rb

@@ -0,0 +1,26 @@
+# @author Khang Le
+
+require 'oauth'
+
+module RailsRunSignUp
+  
+  class Session
+    attr :session
+    attr :access_token
+    attr :api_key
+    attr :api_secret
+    
+    def initialize api_key, api_secret, access_token, access_token_secret, oauth_key, oauth_secret
+      raise RailsRunSignUp::RailsRunSignUpError, "Missing parameter(api_key)" if api_key.nil? || api_key.length == 0
+			raise RailsRunSignUp::RailsRunSignUpError, "Missing parameter(api_secret)" if api_secret.nil? || api_secret.length == 0
+    	raise RailsRunSignUp::RailsRunSignUpError, "Missing parameter(access_token)" if access_token.nil? || access_token.length == 0
+			raise RailsRunSignUp::RailsRunSignUpError, "Missing parameter(access_token_secret)" if access_token_secret.nil? || access_token_secret.length == 0
+      
+      @consumer = OAuth::Consumer.new(oauth_key, oauth_secret, :site => "https://runsignup.com", :request_token_path => "/oauth/requestToken.php", 
+        :authorize_path => "/OAuth/Verify", :access_token_path => "/oauth/accessToken.php")
+      @access_token = OAuth::AccessToken.new(@consumer, access_token, access_token_secret)
+      @api_key = api_key
+      @api_secret = api_secret
+    end
+  end
+end

data/lib/RailsRunSignUp/version.rb

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

data/spec/RailsRunSignUp_helper.rb

@@ -0,0 +1,7 @@
+require 'RailsRunSignUp'
+
+class TestClient
+      def initialize
+
+      end
+end

data/spec/RailsRunSignUp_spec.rb

@@ -0,0 +1,24 @@
+# @author Khang Le
+
+require 'spec_helper'
+
+describe RailsRunSignUp do
+  session = RailsRunSignUp::Session.new(ENV['RSU_API_KEY'],ENV['RSU_API_SECRET'],ENV['RSU_ACCESS_TOKEN'],ENV['RSU_ACCESS_SECRET'], ENV['RSU_OAUTH_TOKEN'], ENV['RSU_OAUTH_SECRET'])
+  
+  it "should create oauth session" do
+    session.should_not be_nil
+  end
+  
+  it "should retrieve race list" do
+    rails_sign_up = RailsRunSignUp::Races.new(session)
+    races = rails_sign_up.get_races 
+    races.should_not be_nil
+  end
+  
+  it "should retrieve race list from search" do
+    rails_sign_up = RailsRunSignUp::Races.new(session)
+    opts = { :events => "T", :name => "Run+Til" }
+    races = rails_sign_up.get_races opts
+    races.should_not be_nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'rspec'
+require 'RailsRunSignUp'
+require 'RailsRunSignUp_helper'
+require "net/http"
+require "uri"
+require "json"
+
+RSpec.configure do |config|
+		config.color_enabled = true
+		config.formatter = 'documentation'
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: RailsRunSignUp
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- David Slone
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: Retrieve races from RunSignUp
+email:
+- dbslone@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- RailsRunSignUp.gemspec
+- Rakefile
+- lib/RailsRunSignUp.rb
+- lib/RailsRunSignUp/exceptions.rb
+- lib/RailsRunSignUp/model/event.rb
+- lib/RailsRunSignUp/model/race.rb
+- lib/RailsRunSignUp/model/registration_period.rb
+- lib/RailsRunSignUp/races.rb
+- lib/RailsRunSignUp/record.rb
+- lib/RailsRunSignUp/session.rb
+- lib/RailsRunSignUp/version.rb
+- spec/RailsRunSignUp_helper.rb
+- spec/RailsRunSignUp_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.0.3
+signing_key: 
+specification_version: 4
+summary: This is a gem to allow an authenticated user to get races/race info from
+  RunSignUp
+test_files:
+- spec/RailsRunSignUp_helper.rb
+- spec/RailsRunSignUp_spec.rb
+- spec/spec_helper.rb