crowdskout 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 67d2e0750c8be6e9368412b8fd03f60664fa9c9f
+  data.tar.gz: 8ab86a1381952837ee0a1fd3ab4dd186afb3ee05
+SHA512:
+  metadata.gz: 382153bfdb158fe5d8c4fc6d6bfee0f457fdbbc093e505ebc06bd67fc1c44347d7aa34340db802af541cc837e895d167403f177500857bc94a1b0434c237eba2
+  data.tar.gz: 64842c469da953513a9e23f99e31968594f7f45d572def406380843f09111a2c4fb7c1e423ca300ecc6918280c8f266ce045559f4877aecd279449358c305c33

data/.rspec

@@ -0,0 +1,2 @@
+--format nested
+--color

data/README.md

@@ -0,0 +1,53 @@
+# Crowdskout
+
+It is a Ruby wrapper for the Crowdskout API.
+
+[![Build Status](https://travis-ci.org/revvco/crowdskout.png?branch=master)](https://travis-ci.org/revvco/crowdskout.png?branch=master)
+
+Visit also a Crowdskout API documentation: [here](http://docs.crowdskout.com/api/#get-the-options-for-a-field)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'crowdskout'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install crowdskout
+
+## Usage
+
+**Example for OAuth provider:**
+
+	require 'crowdskout'
+
+	oauth_provider = Crowdskout::Auth::OAuth2.new(
+        :api_key => client_id,
+        :api_secret => client_secret,
+        :redirect_url => redirect_uri
+      ) 
+
+	url = oauth_provider.get_authorization_url("a_state_param")
+	
+	# after post to URL and granting access
+	access_token = oauth_provider.get_access_token(params[:code])
+
+**Example for Crowdskout API:**
+
+	require 'crowdskout'
+
+	api = Crowdskout::Api.new(api_key, access_token)
+
+	# Fetching profiles
+	profile = api.get_profile(164)
+
+	# Fetching field options
+	field_options = api.get_options_for_a_field("AddressCity")
+
+	# Fetching attributes
+	attributes = api.get_attributes

data/crowdskout.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |s|
+  s.name = "crowdskout"
+  s.version = '0.0.4'
+  s.platform = Gem::Platform::RUBY
+  s.authors = ["Crowdskout", "Revv","Kyle Schutt"]
+  s.homepage = "https://github.com/revvco/crowdskout"
+  s.summary = %q{Crowdskout SDK for Ruby}
+  s.email = "kyle@revv.co"
+  s.description = "Ruby library for interactions with Crowdskout v1 API"
+  s.license = "MIT"
+
+  s.files = [
+    '.rspec',
+    'crowdskout.gemspec',
+    'README.md'
+  ]
+  s.files += Dir['lib/**/*.rb']
+  s.executables = []
+  s.require_paths = [ "lib" ]
+  s.test_files = Dir['spec/**/*_spec.rb']
+  
+  s.add_runtime_dependency("rest-client", '~> 1.6', '>= 1.6.7')
+  s.add_runtime_dependency("json", '~> 1.8', '>= 1.8.1')
+  s.add_runtime_dependency('mime-types', '~> 1.25', '>= 1.25.1')
+  s.add_development_dependency("rspec", '~> 2.14')
+end

data/lib/crowdskout.rb

@@ -0,0 +1,65 @@
+# Copyright, 2016, by Kyle Schutt.
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require 'rubygems'
+require 'rest_client'
+require 'json'
+require 'cgi'
+require 'cgi/session'
+require 'cgi/session/pstore'
+require 'openssl'
+require 'base64'
+
+module Crowdskout
+  autoload :Api, 'crowdskout/api'
+  autoload :VERSION, 'crowdskout/version'
+
+  module Auth
+    autoload :OAuth2, 'crowdskout/auth/oauth2'
+  end
+
+  module Services
+    autoload :BaseService, 'crowdskout/services/base_service'
+    autoload :ProfileService, 'crowdskout/services/profile_service'
+    autoload :FieldService, 'crowdskout/services/field_service'
+    autoload :AttributeService, 'crowdskout/services/attribute_service'
+  end  
+
+  module Components
+    autoload :Component, 'crowdskout/components/component'
+    autoload :ResultSet, 'crowdskout/components/result_set'
+    autoload :Attribute, 'crowdskout/components/attributes/attribute'
+    autoload :Option, 'crowdskout/components/attributes/option'
+    autoload :Profile, 'crowdskout/components/profiles/profile'
+    autoload :Name, 'crowdskout/components/profiles/name'
+    autoload :Gender, 'crowdskout/components/profiles/gender'
+    autoload :FieldOptions, 'crowdskout/components/fields/field_options'
+  end
+
+  module Exceptions
+    autoload :OAuth2Exception, 'crowdskout/exceptions/oauth2_exception'
+    autoload :ServiceException, 'crowdskout/exceptions/service_exception'
+  end
+
+  module Util
+    autoload :Config, 'crowdskout/util/config'
+    autoload :Helpers, 'crowdskout/util/helpers'
+  end
+end

data/lib/crowdskout/api.rb

@@ -0,0 +1,57 @@
+module Crowdskout
+  class Api
+    # Class constructor
+    # @param [String] api_key - Crowdskout API Key
+    # @param [String] access_token - Crowdskout OAuth2 access token
+    # @return
+    def initialize(api_key = nil, access_token = nil)
+      Services::BaseService.api_key = api_key || Util::Config.get('auth.api_key')
+      Services::BaseService.access_token = access_token
+      if Services::BaseService.api_key.nil? || Services::BaseService.api_key == ''
+        raise ArgumentError.new(Util::Config.get('errors.api_key_missing'))
+      end
+      if Services::BaseService.access_token.nil? || Services::BaseService.access_token == ''
+        raise ArgumentError.new(Util::Config.get('errors.access_token_missing'))
+      end
+    end
+
+    # Profile Service Methods
+    def get_profile(profile_id, collections)
+      Services::ProfileService.get_profile(profile_id, collections)
+    end
+    def create_profile(profile, params = {})
+      Services::ProfileService.create_profile(profile, params)
+    end
+    def create_profiles_bulk(profiles)
+      Services::ProfileService.create_profiles_bulk(profiles)
+    end
+    def update_profile(profile)
+      Services::ProfileService.update_profile(profile)
+    end
+    def update_profiles_bulk(profiles)
+      Services::ProfileService.update_profiles_bulk(profiles)
+    end
+
+    # Fields Service Methods
+    def get_options_for_a_field(field_name, params = {})
+      Services::FieldService.get_options_for_a_field(field_name, params)
+    end
+
+    # Attribute Service Methods
+    def get_attributes(params = {})
+      Services::AttributeService.get_attributes(params)
+    end
+    def get_attribute(attribute_id)
+      Services::AttributeService.get_attribute(attribute_id)
+    end
+    def create_attribute(name, type, options = nil)
+      Services::AttributeService.create_attribute(name, type, options)
+    end
+    def update_attribute(attribute_id, params = {})
+      Services::AttributeService.update_attribute(attribute_id, params)
+    end
+    def delete_attribute(attribute_id)
+      Services::AttributeService.delete_attribute(attribute_id)
+    end
+  end
+end

data/lib/crowdskout/auth/oauth2.rb

@@ -0,0 +1,81 @@
+module Crowdskout
+  module Auth
+    class OAuth2
+      attr_accessor :client_id, :client_secret, :redirect_uri, :props
+
+
+      # Class constructor
+      # @param [Hash] opts - the options to create an OAuth2 object with
+      # @option opts [String] :api_key - the Crowdskout API Key
+      # @option opts [String] :api_secret - the Crowdskout secret key
+      # @option opts [String] :redirect_url - the URL where Crowdskout is returning the authorization code
+      # @return
+      def initialize(opts = {})
+        @client_id = opts[:api_key] || Util::Config.get('auth.api_key')
+        @client_secret = opts[:api_secret] || Util::Config.get('auth.api_secret')
+        @redirect_uri = opts[:redirect_url] || Util::Config.get('auth.redirect_uri')
+        if @client_id.nil? || @client_id == '' || @client_secret.nil? || @client_secret.nil? || @redirect_uri.nil? || @redirect_uri == ''
+          raise ArgumentError.new "Either api_key, api_secret or redirect_uri is missing in explicit call or configuration."
+        end
+      end
+
+
+      # Get the URL at which the user can authenticate and authorize the requesting application
+      # @param [String] state - an optional value used by the client to maintain state between the request and callback
+      # @return [String] the authorization URL
+      def get_authorization_url(state = nil)
+        response_type = Util::Config.get('auth.response_type_code')
+        params = {
+          :response_type => response_type,
+          :client_id     => @client_id,
+          :redirect_uri  => @redirect_uri
+        }
+        if state
+            params[:state] = state
+        end
+        [
+          Util::Config.get('auth.base_url'),
+          Util::Config.get('auth.authorization_endpoint'),
+          '?',
+          Util::Helpers.http_build_query(params)
+        ].join
+      end
+
+
+      # Obtain an access token
+      # @param [String] code - the code returned from Crowdskout after a user has granted access to his account
+      # @return [String] the access token
+      def get_access_token(code)
+        params = {
+          :grant_type    => Util::Config.get('auth.authorization_code_grant_type'),
+          :client_id     => @client_id,
+          :client_secret => @client_secret,
+          :code          => code,
+          :redirect_uri  => @redirect_uri
+        }
+
+        url = [
+          Util::Config.get('auth.base_url'),
+          Util::Config.get('auth.token_endpoint')
+        ].join
+
+        response_body = ''
+        begin
+          response = RestClient.post(url, params)
+          response_body = JSON.parse(response)
+        rescue => e
+          response_body = e.respond_to?(:response) && e.response ?
+            JSON.parse(e.response) :
+            {'error' => '', 'error_description' => e.message}
+        end
+
+        if response_body['error_description']
+          error = response_body['error_description']
+          raise Exceptions::OAuth2Exception, error
+        end
+
+        response_body
+      end
+    end
+  end
+end

data/lib/crowdskout/components/attributes/attribute.rb

@@ -0,0 +1,31 @@
+module Crowdskout
+  module Components
+    class Attribute < Component
+      attr_accessor :id, :type, :locked, :name, :options
+
+      def self.create(props)
+        obj = Attribute.new
+        if props
+          props.each do |key, value|
+            if key.downcase == 'options'
+              if value
+                obj.options = []
+                value.each do |option|
+                  obj.options << Components::Option.create(option)
+                end
+              end
+            else
+              obj.send("#{key}=", value) if obj.respond_to? key
+            end
+          end
+        end
+        obj
+      end
+
+      def add_options(option)
+        @options = [] if @options.nil?
+        @options << option
+      end
+    end
+  end
+end

data/lib/crowdskout/components/attributes/option.rb

@@ -0,0 +1,22 @@
+# Copyright (c) 2016 Kyle Schutt. All rights reserved.require 
+
+module Crowdskout
+  module Components
+    class Option < Component
+      attr_accessor :id, :value
+
+      # Factory method to create an Address object from a json string
+      # @param [Hash] props - properties to create object from
+      # @return [Address]
+      def self.create(props)
+        obj = Option.new
+        if props
+          props.each do |key, value|
+            obj.send("#{key}=", value) if obj.respond_to? key
+          end
+        end
+        obj
+      end
+    end
+  end
+end

data/lib/crowdskout/components/component.rb

@@ -0,0 +1,42 @@
+module Crowdskout
+  module Components
+    class Component
+
+      def to_hash
+        hash = Hash.new
+        self.instance_variables.collect do |var|
+          hash[var.to_s[1..-1]] = self.class.to_hash_value(self.instance_variable_get(var))
+        end
+        hash
+      end
+
+      def self.to_hash_value(val)
+        if val.is_a? Crowdskout::Components::Component
+          return val.to_hash
+        elsif val.is_a? Array
+          return val.collect{|subval| Component.to_hash_value(subval) }
+        elsif val.is_a? DateTime
+          return val.to_s
+        else
+          return val
+        end
+      end
+
+      def to_json(val = nil)
+        self.to_hash.to_json
+      end
+
+      protected
+
+      # Get the requested value from a hash, or return the default
+      # @param [Hash] hsh - the hash to search for the provided hash key
+      # @param [String] key - hash key to look for
+      # @param [String] default - value to return if the key is not found, default is null
+      # @return [String]
+      def self.get_value(hsh, key, default = nil)
+        hsh.has_key?(key) and hsh[key] ? hsh[key] : default
+      end
+
+    end
+  end
+end

data/lib/crowdskout/components/fields/field_options.rb

@@ -0,0 +1,31 @@
+module Crowdskout
+  module Components
+    class FieldOptions < Component
+      attr_accessor :id, :collection, :options
+
+      def self.create(props)
+        obj = FieldOptions.new
+        if props
+          props.each do |key, value|
+            if key.downcase == 'options'
+              if value
+                obj.options = []
+                value.each do |option|
+                  obj.options << Components::Option.create(option)
+                end
+              end
+            else
+              obj.send("#{key}=", value) if obj.respond_to? key
+            end
+          end
+        end
+        obj
+      end
+
+      def add_options(option)
+        @options = [] if @options.nil?
+        @options << option
+      end
+    end
+  end
+end

data/lib/crowdskout/components/profiles/gender.rb

@@ -0,0 +1,40 @@
+# Copyright (c) 2016 Kyle Schutt. All rights reserved.require 
+
+module Crowdskout
+  module Components
+    class Gender < Component
+      attr_accessor :id, :gender
+
+      # Factory method to create an Address object from a json string
+      # @param [Hash] props - properties to create object from
+      # @return [Address]
+      def self.create(props)
+        obj = Gender.new
+        if props
+          props.each do |key, value|
+            if key.downcase == 'gender'
+              obj.gender = GenderInfo.create(value)
+            else
+              obj.send("#{key}=", value) if obj.respond_to? key
+            end
+          end
+        end
+        obj
+      end
+    end
+    
+    # Detailed gender information
+    class GenderInfo
+      attr_accessor :id, :value
+      def self.create(props)
+        obj = GenderInfo.new
+        if props
+          props.each do |key, value|
+            obj.send("#{key}=", value) if obj.respond_to? key
+          end
+        end
+        obj
+      end
+    end
+  end
+end