zooppa_api 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4d1955b69eae804f624281b446291d70addabf30
+  data.tar.gz: cf07034a60e450100af697fc22cd7997d3f19fe2
+SHA512:
+  metadata.gz: b11ee07eb513bac401a384a11ab3ca05d384612953ab56d95928e2dbba9e3894394e1cd2f79037e91337a2e35df961b00203a42516f2dba5daa9c61e70852089
+  data.tar.gz: 418450a1544fc58bad188afe10ea3c7e18d7c205499d850f1b31dce9772f1c854478194baed732e59d7b1ff2dada78829156543ed7eb5a1e6ea21782f8d4f585

data/lib/zooppa_api.rb

@@ -0,0 +1,131 @@
+require 'rest_client'
+require 'json'
+require 'active_support/core_ext'
+require 'oauth2'
+require 'encryptor'
+
+# Builds a Rest Request
+# Handles authentication which should slim down logic inside our controllers
+#
+# Each resource controller of Zooppa's API V2 has the following endpoints:
+#   GET       /api/v1/resources.json      resources#index
+#   POST      /api/v1/resources.json      resources#create
+#   GET       /api/v1/resources/:id.json  resources#show
+#   PATCH/PUT /api/v1/resources/:id.json  resources#update
+#   DELETE    /api/v1/resources/:id.json  resources#destroy
+
+## USAGE examples (from the controller)
+
+# GET index#companies (with auth)
+# RestRequest.new('companies', authenticate: true, cookies: cookies).do_request
+
+# GET show#companies (with auth)
+# RestRequest.new('companies', authenticate: true, cookies: cookies, id: '8').do_request
+
+# POST create#companies (with auth)
+# RestRequest.new('companies', authenticate: true, cookies: cookies, method: :post, params: {company: { name: 'company name'}})
+
+# PUT update#companies (with auth)
+# RestRequest.new('companies', authenticate: true, cookies: cookies, method: :put, id: "10", params: {company: { name: 'new company name'}})
+
+# DELETE destroy#companies (with auth)
+# RestRequest.new('companies', authenticate: true, cookies: cookies, method: :delete, id: "10")
+
+class ZooppaApi
+
+  # Initializes the Rest Request
+  # resource: string - resource name - must be plural (i.e. 'invitations', 'companies')
+  # method: sym - HTTP VERB (:post, :put, :delete, :get)
+  # cookies: Rails cookies Object - from controller - is required when 'authenticate' is set to true
+  # params: hash - params from controller
+  # id: integer - resource id - required for show, update & destroy action only
+  # authenticate: boolean - API call requires authentication (true) or not (false)?
+  # api_version: string - specifies version of API - default: v2
+  #
+  # Here we use KEYWORD ARGUMENTS (new in ruby 2.0.0): http://magazine.rubyist.net/?Ruby200SpecialEn-kwarg
+  def initialize(**args)
+    @api_host = args.fetch(:api_host) { 'http://zooppa.com/' }
+    @version = args.fetch(:version) { 'v2' }
+    @app_secret = args.fetch(:app_secret) { 'app_secret' }
+    @app_id = args.fetch(:app_id) { 'app_id' }
+    @encrypt = args.fetch(:encrypt) { true }
+    # needed for encrypting the access token
+    @iv = OpenSSL::Cipher::Cipher.new('aes-128-cbc').random_iv
+  end
+
+  # Executes the request
+  def do_request(resource, **args)
+    prepare_request(resource, **args)
+    if [:post, :put, :patch].include?(@method)
+      JSON.parse(RestClient.send(@method, @url, @params))
+    else
+      JSON.parse(RestClient.send(@method, @url))
+    end
+  end
+
+  def prepare_request(resource, **args)
+    @resource = resource
+    @method = args.fetch(:method) { :get }
+    @id = args.fetch(:id) { nil }
+    @params = args.fetch(:params) { {} }
+    @cookies = args.fetch(:cookies) { {} }
+    @authenticate = args.fetch(:authenticate) { false }
+    @url = build_url
+
+    if @authenticate
+      fail Exceptions::MissingAuthToken unless @cookies.key?(:auth_token)
+      add_auth_token
+    end
+  end
+
+  # Builds the URL (adds an id of provided)
+  def build_url
+    url = @api_host + 'api/' + @version + '/' + @resource
+    url += '/' + @id if @id
+    url += '.json'
+    url += '?' + @params.to_param if [:get, :delete].include?(@method) && !@params.empty?
+    url
+  end
+
+  # Adds the auth_token to the params hash or url (depending on the HTTP verb)
+  def add_auth_token
+    if @encrypt && @authenticate
+      token = decrypt_token(@cookies[:auth_token])
+    else
+      token = @cookies[:auth_token]
+    end
+
+    if [:get, :delete].include?(@method) && !@params.empty?
+      @url += '&access_token=' + token
+    elsif [:get, :delete].include?(@method) && @params.empty?
+      @url += '?access_token=' + token
+    else
+      @params.merge!(access_token: token)
+    end
+  end
+
+  def authenticate(email, password)
+    client = OAuth2::Client.new(
+               @app_id,
+               @app_secret,
+               site: @api_host
+              )
+    token = client.password.get_token(email, password).token
+    @encrypt ? encrypt_token(token) : token
+  rescue => e
+    parse_error_message(e)
+  end
+
+  def decrypt_token(encrypted_token)
+    Encryptor.decrypt(encrypted_token, :key => @app_id, :iv => @iv, :salt =>  @app_secret)
+  end
+
+  def encrypt_token(token)
+    Encryptor.encrypt(token, :key => @app_id, :iv => @iv, :salt =>  @app_secret)
+  end
+
+  def parse_error_message(e)
+    msg = e.try(:code) == 'invalid_resource_owner' ? 'Invalid email or password.' : 'There seems to be a connection problem'
+    { error: msg }
+  end
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: zooppa_api
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- Ulrich Soeffing
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: encryptor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Easy peasy communication for the API of Zooppa
+email: ulrich.soeffing@staunchrobots.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/zooppa_api.rb
+homepage: http://github.com/soeffing/zooppa_api
+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.1.11
+signing_key: 
+specification_version: 4
+summary: Ruby Wrapper for Zooppa's API
+test_files: []