client_libraries

Created: 2012-03-22 19:44
Updated: 2013-12-17 10:49

README.markdown

Scaffold Client Library Instructions

Building the Libraries

Ruby

To build the GEM, do the following:

rake manifest

rake build_gemspec

Java

To build the JAR, do the following:

  • Right click on the project in Eclipse, and choose Export
  • Export output folders
  • Uncheck everything other than .classpath and Manifest
  • Save the JAR somewhere outside of the current project

Generating the Documentation

PHP

phpdoc run -f scaffold-api.php -t phpdoc

Ruby

rdoc --op rdoc -main lib/scaffold-api.rb

Java

javadoc -d javadoc -sourcepath src -classpath gson-2.1.jar -verbose com.getscaffold

Python

pydoc -w scaffold

mv scaffold.html pydoc/

Setting up the Libraries

Ruby

Insert the following line into your Gemfile:

gem "scaffold-api", :git => "git@github.com:Getscaffold/client_libraries.git"

Java

Download scaffold-api.jar and gson-2.1.jar, and add them to your classpath

PHP

Copy scaffold-api.php and url_signing.php into your project

You will need to install pear and pecl_http, since pecl_http is required by this library.

wget http://pear.php.net/go-pear.phar

php -d detect_unicode=0 go-pear.phar

pecl install pecl_http

Once you have installed the dependencies, you should be able to use the library with the following include command

include 'url_signing.php';

Python

Copy scaffold.py into your project, and add the following import

import scaffold

Cookies help us deliver our services. By using our services, you agree to our use of cookies Learn more