GitHub - Cashbury/monopoly: hackbox for the hackathon project

Branches Tags

Name		Name	Last commit message	Last commit date
Latest commit History 950 Commits
.idea		.idea
.redcar		.redcar
app		app
autotest		autotest
config		config
db		db
doc		doc
features		features
lib		lib
public		public
script		script
spec		spec
test		test
tmp		tmp
vendor/plugins		vendor/plugins
.gitCOMMIT_EDITMSG		.gitCOMMIT_EDITMSG
.gitignore		.gitignore
.rspec		.rspec
Capfile		Capfile
Gemfile		Gemfile
Gemfile.lock		Gemfile.lock
Guardfile		Guardfile
README		README
Rakefile		Rakefile
config.ru		config.ru
coverage.data		coverage.data
google3cdf46b988c30c13.html		google3cdf46b988c30c13.html
wkhtmltopdf-0.9.9-static-i386.tar.bz2		wkhtmltopdf-0.9.9-static-i386.tar.bz2

Repository files navigation

==  Welcome to Kazdoor ==

1. Available APIs
	2. Businesses
		3. List all businesses
			request:
				http://username:password@spinninghats.com/businesses [xml]
			request type:
				GET
			response:
				<?xml version="1.0" encoding="UTF-8"?>
				<businesses type="array">
				  <business>
				    <name>Gloria Jeans</name>
				    <created-at type="datetime">2011-01-23T13:30:06Z</created-at>
				    <updated-at type="datetime">2011-01-23T13:30:06Z</updated-at>
				    <id type="integer">1</id>
				    <description>Coffee Shop</description>
				  </business>
				</businesses>
				
		3. Display a business properties
			request:
				http://spinninghats.com/businesses/1 [xml]
			request type:
				GET
			response:
				<?xml version="1.0" encoding="UTF-8"?>
				<business>
				  <name>Gloria Jeans</name>
				  <created-at type="datetime">2011-01-23T13:30:06Z</created-at>
				  <updated-at type="datetime">2011-01-23T13:30:06Z</updated-at>
				  <id type="integer">1</id>
				  <description>Coffee Shop</description>
				</business>
				
		3. Display a list of rewards available for a business
			request:
				http://spinninghats.com/businesses/1/rewards [xml]
			request type:
				GET
			response:
				<?xml version="1.0" encoding="UTF-8"?>
				<rewards type="array">
				  <reward>
				    <name>Free cup of coffee</name>
				    <created-at type="datetime">2011-01-23T13:30:06Z</created-at>
				    <place-id type="integer" nil="true"></place-id>
				    <available type="datetime" nil="true"></available>
				    <updated-at type="datetime">2011-01-23T13:30:06Z</updated-at>
				    <id type="integer">1</id>
				    <points type="integer" nil="true"></points>
				    <business-id type="integer">1</business-id>
				    <claim type="integer" nil="true"></claim>
				    <description nil="true"></description>
				  </reward>
				</rewards>
				
		3. Display a list of places associated with a business
			request:
				http://spinninghats.com/businesses/1/places [xml]
			request type:
				GET
			response:
				<?xml version="1.0" encoding="UTF-8"?>
				<places type="array">
				  <place>
				    <address1 nil="true"></address1>
				    <city nil="true"></city>
				    <name>Hamra</name>
				    <address2 nil="true"></address2>
				    <created-at type="datetime">2011-01-23T13:30:06Z</created-at>
				    <country nil="true"></country>
				    <updated-at type="datetime">2011-01-23T13:30:06Z</updated-at>
				    <zipcode nil="true"></zipcode>
				    <id type="integer">1</id>
				    <business-id type="integer">1</business-id>
				    <neighborhood nil="true"></neighborhood>
				    <description>Makdessi Street</description>
				    <lat>35,480575</lat>
				    <long>33,896499</long>
				  </place>
				</places>
				
		3. Display a list of engagements associated with a business
			request:
				http://spinninghats.com/businesses/1/engagements [xml]
			request type:
				GET
			response:
				<?xml version="1.0" encoding="UTF-8"?>
				<engagements type="array">
				  <engagement>
				    <name>Hello world</name>
				    <created-at type="datetime">2011-01-23T13:49:39Z</created-at>
				    <place-id type="integer" nil="true"></place-id>
				    <updated-at type="datetime">2011-01-23T13:49:39Z</updated-at>
				    <id type="integer">1</id>
				    <points>20</points>
				    <business-id type="integer">1</business-id>
				    <engagement-type>stamp</engagement-type>
				    <description nil="true"></description>
				    <state>pending</state>
				  </engagement>
				</engagements>
				
		3. Display a list of engagements, that are of type stamps, associated with a business
			request:
				http://spinninghats.com/businesses/1/engagements/stamps [xml]
			request type:
				GET
			response:
				<?xml version="1.0" encoding="UTF-8"?>
				<engagements type="array">
				  <engagement>
				    <name>Hello world</name>
				    <created-at type="datetime">2011-01-23T13:49:39Z</created-at>
				    <place-id type="integer" nil="true"></place-id>
				    <updated-at type="datetime">2011-01-23T13:49:39Z</updated-at>
				    <id type="integer">1</id>
				    <points>20</points>
				    <business-id type="integer">1</business-id>
				    <engagement-type>stamp</engagement-type>
				    <description nil="true"></description>
				    <state>pending</state>
				  </engagement>
				</engagements>
	
	2. places
		2.1. Display a place fetched by coordinates
			request:
				http://spinninghats.com/places/33,896499/35,480575 [xml]
			request type:
				GET
			response:
				<?xml version="1.0" encoding="UTF-8"?>
				<place>
				  <address1 nil="true"></address1>
				  <city nil="true"></city>
				  <name>Hamra</name>
				  <address2 nil="true"></address2>
				  <created-at type="datetime">2011-01-23T13:49:39Z</created-at>
				  <country nil="true"></country>
				  <updated-at type="datetime">2011-01-23T13:49:39Z</updated-at>
				  <zipcode nil="true"></zipcode>
				  <id type="integer">1</id>
				  <business-id type="integer">1</business-id>
				  <neighborhood nil="true"></neighborhood>
				  <description>Makdessi Street</description>
				  <lat>35,480575</lat>
				  <long>33,896499</long>
				</place>
				
		2.2. Display a list of places
			request:
				http://spinninghats.com/places [xml]
			request type:
				GET
			response:
				<?xml version="1.0" encoding="UTF-8"?>
				<places type="array">
				  <place>
				    <address-id type="integer">1</address-id>
				    <business-id type="integer">9</business-id>
				    <created-at type="datetime">2011-05-30T15:10:00Z</created-at>
				    <about>Some description</about>
				    <foursquare-reference nil="true"/>
				    <google-reference>
				      CnRiAAAAyacZ9xcMdwb30jhW6-gtu1IFBwPpT4m8fshrRRQHwu0eDMJKBCvRhDyE-cpDrQK3WVJgDiCDNhWsfemeWTMWJqx7HAtZdLnUS_uqCgb6Xrg1PtntO1Sui-z2hOVM7iTszm8RpvpuZXtjMD_lcxG7JxIQc4M3LKB23ezdZyH7B5O9iRoUzebDr8MNSCDBhYdsEJba_lmDJhA
				    </google-reference>
				    <id type="integer">10</id>
				    <is-primary type="boolean">false</is-primary>
				    <is-user-defined type="boolean" nil="true"/>
				    <lat type="decimal">31.2135</lat>
				    <long type="decimal">29.9443</long>
				    <name>San Stefano</name>
				    <phone>0020101664281</phone>
				    <place-type-id type="integer" nil="true"/>
				    <time-zone>Cairo</time-zone>
				    <updated-at type="datetime">2011-12-27T20:11:40Z</updated-at>
				    <user-id type="integer" nil="true"/>
				    <status>Closed</status>
				  </place>
				</places>

		2.3. Get information about a place
			request:
				http://spinninghats.com/places/1 [xml]
			request type:
				GET
			response:
				<?xml version="1.0" encoding="UTF-8"?>
				<place>
				  <address-id type="integer">1</address-id>
				  <business-id type="integer">9</business-id>
				  <created-at type="datetime">2011-05-30T15:10:00Z</created-at>
				  <about>Some description</about>
				  <foursquare-reference nil="true"></foursquare-reference>
				  <google-reference>CnRiAAAAyacZ9xcMdwb30jhW6-gtu1IFBwPpT4m8fshrRRQHwu0eDMJKBCvRhDyE-cpDrQK3WVJgDiCDNhWsfemeWTMWJqx7HAtZdLnUS_uqCgb6Xrg1PtntO1Sui-z2hOVM7iTszm8RpvpuZXtjMD_lcxG7JxIQc4M3LKB23ezdZyH7B5O9iRoUzebDr8MNSCDBhYdsEJba_lmDJhA</google-reference>
				  <id type="integer">10</id>
				  <is-primary type="boolean">false</is-primary>
				  <is-user-defined type="boolean" nil="true"></is-user-defined>
				  <lat type="decimal">31.2135</lat>
				  <long type="decimal">29.9443</long>
				  <name>San Stefano</name>
				  <phone>0020101664281</phone>
				  <place-type-id type="integer" nil="true"></place-type-id>
				  <time-zone>Cairo</time-zone>
				  <updated-at type="datetime">2011-12-27T20:11:40Z</updated-at>
				  <user-id type="integer" nil="true"></user-id>
				  <open-hours type="array">
				    <open-hour>
				      <created-at type="datetime">2011-12-28T04:03:26Z</created-at>
				      <day-no type="integer">0</day-no>
				      <from type="datetime">2000-01-01T09:00:00Z</from>
				      <id type="integer">85</id>
				      <place-id type="integer">10</place-id>
				      <to type="datetime">2000-01-01T11:00:00Z</to>
				      <updated-at type="datetime">2011-12-28T04:03:26Z</updated-at>
				    </open-hour>
				    <open-hour>
				      <created-at type="datetime">2011-12-28T04:03:26Z</created-at>
				      <day-no type="integer">0</day-no>
				      <from type="datetime">2000-01-01T16:00:00Z</from>
				      <id type="integer">86</id>
				      <place-id type="integer">10</place-id>
				      <to type="datetime">2000-01-01T18:00:00Z</to>
				      <updated-at type="datetime">2011-12-28T04:03:26Z</updated-at>
				    </open-hour>
				    <open-hour>
				      <created-at type="datetime">2011-12-28T04:03:26Z</created-at>
				      <day-no type="integer">1</day-no>
				      <from type="datetime">2000-01-01T13:00:00Z</from>
				      <id type="integer">87</id>
				      <place-id type="integer">10</place-id>
				      <to type="datetime">2000-01-01T20:00:00Z</to>
				      <updated-at type="datetime">2011-12-28T04:03:26Z</updated-at>
				    </open-hour>
				  </open-hours>
				</place>

	2. Engagements
		3. Display an engagement
			request:
				http://spinninghats.com/engagements/1 [xml]
			request type:
				GET
			response:
				<?xml version="1.0" encoding="UTF-8"?>
				<engagement>
				  <name>Hello world</name>
				  <created-at type="datetime">2011-01-23T13:49:39Z</created-at>
				  <place-id type="integer" nil="true"></place-id>
				  <updated-at type="datetime">2011-01-23T13:49:39Z</updated-at>
				  <id type="integer">1</id>
				  <points>20</points>
				  <business-id type="integer">1</business-id>
				  <engagement-type>stamp</engagement-type>
				  <description nil="true"></description>
				  <state>pending</state>
				</engagement>

	2. Activities
		3. Store an activity of type "EARN"
			request:
				http://spinninghats.com/activities/earn [xml]
			request type:
				POST
			request body:
				<?xml version="1.0" encoding="UTF-8"?>
				<report>
		    	<user-id>1</user-id>
		    	<engagement-id>1</engagement-id>
		    	<reward-id>1</reward-id>
					<place-id>1</place-id>
					<points>23</points>
				</report>
				
		3. Store an activity of type "SPEND"
			request:
				http://spinninghats.com/activities/spend [xml]
			request type:
				POST
			request body:
				<report>
		    	<user-id>1</user-id>
		    	<engagement-id>1</engagement-id>
		    	<reward-id>1</reward-id>
					<place-id>1</place-id>
					<points>5</points>
				</report>