Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion Gemfile.lock
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
PATH
remote: .
specs:
check_appointments (0.0.1)

GEM
remote: https://rubygems.org/
Expand All @@ -14,3 +13,6 @@ PLATFORMS
DEPENDENCIES
check_appointments!
rake

BUNDLED WITH
1.11.2
38 changes: 38 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# The Check Appointments Ruby Gem
A Ruby wrapper for the Check Appointments API

## <a name="installation">Installation</a>
Add it to your Gemfile:
gem 'check_appointments'
Run the following command to install it:
bundle install
Or from the command line, run:
gem install check_appointments

#Setup & Configuration
1. Make an initializer by creating a file called check_appointments.rb in 'config\initializers' and adding the following to the file:

<b></b>
# Added to your config\initializers file
CheckAppointments.configure do |config|
config.api_key = 'YOUR_CHECK_APPOINTMENTS_API_KEY'
config.private_key = 'YOUR_CHECK_APPOINTMENTS_PRIVATE_KEY'
config.base_url = 'https://checkappointments.com/businessWeb'
end

#Usage Example(s)
#Get all the appointments, this might take a while if you have a lot of them.
CheckAppointments::Appointment.find_all

#Contribute
Please feel free to help out in any way you can. Make a suggestion, correct a typo, report a bug, etc.

#Submitting an Issue
We use the GitHub Issue Tracker to track bugs and features.

#Supported Rubies
* Ruby = 1.8.7
* Ruby >= 1.9

#Todos
* Need to fully implement testing
Binary file added check_appointments-0.0.8.gem
Binary file not shown.
2 changes: 1 addition & 1 deletion check_appointments.gemspec
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Gem::Specification.new do |s|
s.name = %q{check_appointments}
s.version = "0.0.5"
s.version = "0.0.8"
s.date = %q{2015-02-18}
s.summary = %q{Gem that interfaces with the CheckAppointments API}
s.files = Dir["README.md","Gemfile","Rakefile", "lib/**/*"]
Expand Down