personal_api_client 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.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/README.md

@@ -0,0 +1,65 @@
+personal_api_client.gem
+=======================
+
+#INSTRUCTIONS:
+
+1. Build the gem with following command: gem build personal_api_client.gemspec
+2. Put following line in Gemfile of your application: gem 'personal_api_client', :path => "path_to_the_folder_where_your_gem_is"
+3. Run bundle command
+4. Congrats! You've succesfully built and installed the gem.
+
+
+5. Getting the access token:
+	5.1 Initialize your Personal Oauth2 Client: client = Oauth2Client.initialize_auth_code(parameters) where parameters are:
+
+	{:client_id => your_client_id, 
+     :client_secret => your_client_secret, 
+     :target_site => api_endpoint_i_e_https://api-sandbox.personal.com, 
+     :callback_uri => path_to_your_method_where_authorization_code_will_be_sent_i_e_oauth2/my_callback_method, 
+     :scope => scope_as_per_http://developer.personal.com/docs/read/authentication/Authorization_Code}
+
+    5.2 Redirect to authorize URL (recirect_to client.authorize_url)
+
+    5.3 Authorization code will arrive to the callback URL you specified in :callback_uri. Call get_access_token:
+    access_token = client.get_access_token(parameters) where parameters are:
+
+    {:code => params[:code],
+	 :callback_uri => the_same_as_in_previous_request}
+
+6. Get the data
+	6.1 Initialize Personal API Client:
+	personal_api_client = PersonalApiClient.new(access_token, your_client_id)
+
+	6.2 Use some of the methods of the client to manipulate data (consult http://developer.personal.com/docs if you need to assemble request body):
+
+
+	Getting List of Gems
+  	get_list_of_gems
+    
+    Read Existing Gem
+  	get_gem(gem_instance_id)
+    
+  	Write to Existing Gem
+  	write_existing_gem(gem_instance_id, body, client_password)
+    
+  	Create New Gem
+  	create_gem(body, client_password)
+
+  	Delete Existing Gem
+  	delete_gem(gem_instance_id)
+    
+    Remove Gem Access
+  	remove_gem_access(gem_instance_id, owner_id=nil)
+    
+  	Get Gem Schema
+  	get_gem_schema(gem_template_id=nil)
+    
+  	Get Gem Schema Version
+  	get_gem_schema_version
+    
+  	Granting Access
+  	grant_access(body, client_password)
+    
+  	Requesting Access
+  	request_access(body)
+    

data/lib/oauth2_client.rb

@@ -0,0 +1,81 @@
+require 'oauth2'
+
+class Oauth2Client
+  @@oauth_config = nil
+  @@callback_uri = nil
+
+  attr_accessor :authorize_url
+  attr_accessor :strategy
+  attr_accessor :client
+
+  def self.initialize_auth_code(options={})
+    c = Oauth2Client.new(options[:client_id], options[:client_secret], options[:target_site])
+    c.authorize_url = c.client.auth_code.authorize_url(:redirect_uri => options[:callback_uri], :scope => options[:scope])
+    c.strategy = :auth_code
+    @@callback_uri = Oauth2Client.callback_uri
+    c
+  end
+
+  def self.initialize_client_auth(options={})
+    c = Oauth2Client.new(options[:client_id], options[:client_secret], options[:target_site])
+    c.strategy = :client_credentials
+    c
+  end
+
+  def self.initialize_from_configuration(path)
+    @@oauth_config = YAML.load_file(File.new(path)) unless @@oauth_config
+    Oauth2Client.initialize_auth_code({:client_id => Oauth2Client.client_id, 
+                                       :client_secret => Oauth2Client.client_secret, 
+                                       :target_site => Oauth2Client.target_site, 
+                                       :callback_uri => Oauth2Client.callback_uri, 
+                                       :scope => Oauth2Client.scope})
+  end
+
+  def get_access_token(options={})
+    params = prepare_params options
+    @client.send(strategy).send(:get_token, *params)    
+  end
+
+  def self.callback_uri
+    return @@callback_uri if @@callback_uri
+    @@oauth_config[site]["my_site"] + @@oauth_config[site]["callback_uri"]
+  end
+ 
+  private
+  def initialize(client_id, client_secret, target_site)
+    @client = OAuth2::Client.new(client_id, client_secret, :site => target_site)
+  end
+  
+  def self.site
+    @@oauth_config["site"]
+  end
+
+  def self.scope
+    @@oauth_config[site]["scope"]
+  end
+  
+  def self.client_id
+    @client_id = @@oauth_config[site]["client_id"]
+  end
+
+  def self.client_secret
+    @@oauth_config[site]["client_secret"]
+  end
+
+  def self.target_site
+    @@oauth_config[site]["target_site"]
+  end
+
+  def prepare_params(params)
+    if strategy==:auth_code
+      raise Oauth2ClientException("You must specify code and callback_uri") unless params[:code] && params[:callback_uri]
+      return_list = [params[:code], {:redirect_uri=>params[:callback_uri]}]
+    elsif strategy==:client_credentials
+      return_list = []
+    end
+    return_list
+  end
+end
+
+class Oauth2ClientException < Exception
+end

data/lib/personal_api_client.rb

@@ -0,0 +1,97 @@
+require 'oauth2_client'
+
+# TODO: create body builders for post request and make post requests parametrized
+class PersonalApiClient
+  API_VERSION_1 = "v1"
+  API_PATH = "api"
+
+  attr_accessor :client_id
+
+  def api_path
+    "/#{API_PATH}/#{API_VERSION_1}"
+  end
+
+  def initialize(at, cl_id)
+    @access_token = at
+    @client_id = cl_id
+  end
+
+  #Getting List of Gems
+  def get_list_of_gems
+    get(add_client_id_to "#{api_path}/gems/")
+  end
+
+  #Read Existing Gem
+  def get_gem(gem_instance_id)
+    get(add_client_id_to "#{api_path}/gems/#{gem_instance_id}")
+  end
+
+  #Write to Existing Gem
+  def write_existing_gem(gem_instance_id, body, client_password)
+    put(add_client_id_to "#{api_path}/gems/#{gem_instance_id}", {:body=>body, :headers=>{"Secure-Password"=>client_password }})
+  end
+
+  #Create New Gem
+  def create_gem(body, client_password)
+    post(add_client_id_to "#{api_path}/gems/", {:body=>body, :headers=>{"Secure-Password"=>client_password}})
+  end
+
+  #Delete Existing Gem
+  def delete_gem(gem_instance_id)
+    delete(add_client_id_to "#{api_path}/gems/#{gem_instance_id}")
+  end
+
+  #Remove Gem Access
+  def remove_gem_access(gem_instance_id, owner_id=nil)
+    delete(add_client_id_to "#{api_path}/gems/#{gem_instance_id}/access/#{owner_id}")
+  end
+
+  #Get Gem Schema
+  def get_gem_schema(gem_template_id=nil)
+    path_to_schema = "#{api_path}/schema"
+    path_to_schema.concat("/#{gem_template_id}") if gem_template_id
+    get(add_client_id_to path_to_schema)
+  end
+
+  #Get Gem Schema Version
+  def get_gem_schema_version
+    get(add_client_id_to "#{api_path}/schema/version")
+  end
+
+  #Granting Access
+  def grant_access(body, client_password)
+    post(add_client_id_to "#{api_path}/access/grant", {:body=>body, :headers=>{"Secure-Password"=>client_password}})
+  end
+
+  #Requesting Access
+  def request_access(body)
+    post(add_client_id_to "#{api_path}/access/request", :body=>body)
+  end
+
+  protected
+  def get(resource, params = {})
+    fire(__method__, resource, :params => params)
+  end
+
+  def post(resource, params = {})
+    fire(__method__, resource, :params => params)
+  end
+
+  def put(resource, params = {})
+    fire(__method__, resource, :params => params)
+  end
+
+  def delete(resource, params = {})
+    fire(__method__, resource, :params => params)
+  end
+
+  private
+  def fire(method_name, resource, params)
+    response = @access_token.method(method_name).call(resource, :params => params)
+    return response.status, response.parsed
+  end
+
+  def add_client_id_to(url)
+    "#{url}?client_id=#{client_id}"
+  end
+end

data/lib/personal_api_client/version.rb

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

data/personal_api_client.gemspec

@@ -0,0 +1,19 @@
+$:.push File.expand_path("../lib", __FILE__)
+require "personal_api_client/version"
+
+Gem::Specification.new do |s|
+  s.name        = 'personal_api_client'
+  s.version     = PersonalApi::VERSION
+  s.date        = '2012-10-31'
+  s.summary		= "Personal API Client"
+  s.description = "Personal library for easier interaction with Personal API"
+  s.authors     = ["Adnan Karac"]
+  s.add_runtime_dependency "oauth2", ["= 0.8.0"]
+  s.email       = 'adnan@personal.com'
+  s.files       = `git ls-files`.split($\)
+  s.require_paths = ["lib"]
+  s.rubyforge_project = 'personal_api_client'
+  s.homepage    = ""
+  #["lib/oauth2_client.rb", "lib/personal_api_client.rb"]
+end
+

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: personal_api_client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Adnan Karac
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: oauth2
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+description: Personal library for easier interaction with Personal API
+email: adnan@personal.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- README.md
+- lib/oauth2_client.rb
+- lib/personal_api_client.rb
+- lib/personal_api_client/version.rb
+- personal_api_client.gemspec
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: personal_api_client
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Personal API Client
+test_files: []