crowdskout 0.0.4

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

@@ -0,0 +1,22 @@
+# Copyright (c) 2016 Kyle Schutt. All rights reserved.require 
+
+module Crowdskout
+  module Components
+    class Name < Component
+      attr_accessor :id, :FullName, :NameTitle, :FirstName, :MiddleName, :LastName, :NameSuffix
+
+      # 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 = Name.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/profiles/profile.rb

@@ -0,0 +1,44 @@
+module Crowdskout
+  module Components
+    class Profile < Component
+      attr_accessor :id, :names, :genders
+
+      def self.create(props)
+        obj = Profile.new
+        if props
+          props.each do |key, value|
+            if key.downcase == 'names'
+              if value
+                obj.names = []
+                value.each do |name|
+                  obj.names << Components::Name.create(name)
+                end
+              end
+            elsif key.downcase == 'genders'
+              if value
+                obj.genders = []
+                value.each do |gender|
+                  obj.genders << Components::Gender.create(gender)
+                end
+              end
+            else
+              obj.send("#{key}=", value) if obj.respond_to? key
+            end
+          end
+        end
+        obj
+      end
+
+      def add_names(name)
+        @names = [] if @names.nil?
+        @names << name
+      end
+
+      def add_genders(gender)
+        @genders = [] if @genders.nil?
+        @genders << gender
+      end
+
+    end
+  end
+end

data/lib/crowdskout/components/result_set.rb

@@ -0,0 +1,15 @@
+#
+# result_set.rb
+#
+# Copyright (c) 2016 Kyle Schutt. All rights reserved.
+
+module Crowdskout
+  module Components
+    class ResultSet
+      attr_accessor :results, :next
+      def initialize(results, meta)
+        @results = results
+      end
+    end
+  end
+end

data/lib/crowdskout/exceptions/oauth2_exception.rb

@@ -0,0 +1,5 @@
+module Crowdskout
+  module Exceptions
+    class OAuth2Exception < Exception; end
+  end
+end

data/lib/crowdskout/exceptions/service_exception.rb

@@ -0,0 +1,5 @@
+module Crowdskout
+  module Exceptions
+    class ServiceException < Exception; end
+  end
+end

data/lib/crowdskout/services/attribute_service.rb

@@ -0,0 +1,66 @@
+module Crowdskout
+  module Services
+    class AttributeService < BaseService
+      class << self
+
+        # More info - http://docs.crowdskout.com/api/#get-all-attributes
+        # @param params - query parameters
+        #         - limit - the number of attributes to limit
+        #         - offset - the number of attributes to skip        
+        def get_attributes(params = {})
+          url = Util::Config.get('endpoints.base_url') + Util::Config.get('endpoints.attributes')
+          url = build_url(url, params)
+
+          response = RestClient.get(url, get_headers())
+          body = JSON.parse(response.body)
+
+          attributes = []
+          body['data']['list'].each do |attribute|
+            attributes << Components::Attribute.create(attribute)
+          end if body['data']["total"] > 0
+
+          Components::ResultSet.new(attributes, body['messages'])
+        end
+
+        # more info - http://docs.crowdskout.com/api/#get-an-attribute-by-id
+        # @param [Integration] attribute_id - the id of the attribute to fetch
+        def get_attribute(attribute_id)
+          raise Exceptions::ServiceException, "Attribute ID is required." if attribute_id.nil?
+          url = Util::Config.get('endpoints.base_url') +
+                sprintf(Util::Config.get('endpoints.crud_attribute'), attribute_id)
+          url = build_url(url)
+          response = RestClient.get(url, get_headers())
+          Components::Attribute.create(JSON.parse(response.body)["data"])
+        end
+
+        # more info - http://docs.crowdskout.com/api/#create-an-attribute
+        def create_attribute(new_attribute)
+          raise Exceptions::ServiceException, "Attribute must not be nil" if new_attribute.nil?
+          url = Util::Config.get('endpoints.base_url') + Util::Config.get('endpoints.attribute')
+          url = build_url(url)
+          payload = new_attribute.to_json
+          response = RestClient.post(url, payload, get_headers())
+          Components::Attribute.create(JSON.parse(response.body)["data"])
+        end
+
+        # more info - http://docs.crowdskout.com/api/#update-an-attribute
+        def update_attribute(attribute_id, params = {})
+          raise Exceptions::ServiceException, "Attribute ID is required." if attribute_id.nil?
+          url = Util::Config.get('endpoints.base_url') + sprintf(Util::Config.get('endpoints.crud_attribute'), attribute_id)
+          url = build_url(url)
+          response = RestClient.put(url, params, get_headers())
+          Components::Attribute.create(JSON.parse(response.body)["data"])
+        end
+
+        # more info - http://docs.crowdskout.com/api/#delete-an-attribute
+        def delete_attribute(attribute_id)
+          raise Exceptions::ServiceException, "Attribute ID is required." if attribute_id.nil?
+          url = Util::Config.get('endpoints.base_url') + sprintf(Util::Config.get('endpoints.crud_attribute'), attribute_id)
+          url = build_url(url)
+          response = RestClient.delete(url, get_headers())
+          response.code == 204
+        end
+      end
+    end
+  end
+end

data/lib/crowdskout/services/base_service.rb

@@ -0,0 +1,50 @@
+module Crowdskout
+  module Services
+    class BaseService
+      class << self
+        attr_accessor :api_key, :access_token
+
+        protected
+
+        # Return required headers for making an http request with Crowdskout
+        # @param [String] content_type - The MIME type of the body of the request, default is 'application/json'
+        # @return [Hash] - authorization headers
+        def get_headers(content_type = 'application/json')
+          {
+            :content_type   => content_type,
+            :accept         => 'application/json',
+            :authorization  => "Bearer #{BaseService.access_token}",
+            :user_agent     => "AppConnect Ruby SDK v#{Crowdskout::VERSION} (#{RUBY_DESCRIPTION})",
+            :x_ctct_request_source => "sdk.ruby.#{Crowdskout::VERSION}"
+          }
+        end
+
+        # Build a url from the base url and query parameters hash. Query parameters
+        # should not be URL encoded because this method will handle that
+        # @param [String] url - The base url
+        # @param [Hash] params - A hash with query parameters
+        # @return [String] - the url with query parameters hash 
+        def build_url(url, params = nil)
+          if params.respond_to? :each
+            params.each do |key, value|
+              # Convert dates to CC date format
+              if value.respond_to? :iso8601
+                params[key] = value.iso8601
+              end
+
+              if key.to_s == 'next' && value.match(/^.*?next=(.*)$/)
+                params[key] = $1
+              end
+            end
+          else
+            params ||= {}
+          end
+
+          params['api_key'] = BaseService.api_key
+          url += '?' + Util::Helpers.http_build_query(params)
+        end
+
+      end
+    end
+  end
+end

data/lib/crowdskout/services/field_service.rb

@@ -0,0 +1,17 @@
+module Crowdskout
+  module Services
+    class FieldService < BaseService
+      class << self
+        # more info - http://docs.crowdskout.com/api/#get-the-options-for-a-field
+        def get_options_for_a_field(field_name, params = {})
+          raise Exceptions::ServiceException, "Field name is required." if field_name.nil?
+          url = Util::Config.get('endpoints.base_url') +
+                sprintf(Util::Config.get('endpoints.fields_options'), field_name)
+          url = build_url(url, params)
+          response = RestClient.get(url, get_headers())
+          Components::FieldOptions.create(JSON.parse(response.body)["data"])
+        end
+      end
+    end
+  end
+end

data/lib/crowdskout/services/profile_service.rb

@@ -0,0 +1,76 @@
+module Crowdskout
+  module Services
+    class ProfileService < BaseService
+      class << self
+        # more info - http://docs.crowdskout.com/api/#get-a-profile-by-id
+        def get_profile(profile_id, collections)
+          raise Exceptions::ServiceException, "Profile ID is required." if profile_id.nil?
+          raise Exceptions::ServiceException, "A comma-deliminted list of collections is required." if collections.nil?
+          params = {
+            collections: collections
+          }
+          url = Util::Config.get('endpoints.base_url') +
+                sprintf(Util::Config.get('endpoints.crud_profile'), profile_id)
+          url = build_url(url, params)
+
+          response = RestClient.get(url, get_headers())
+          Components::Profile.create(JSON.parse(response.body)["data"])
+        end
+
+        # more info - http://docs.crowdskout.com/api/#create-a-profile
+        def create_profile(profile, params = {})
+          raise Exceptions::ServiceException, "Profile object must not be nil." if profile.nil?
+          url = Util::Config.get('endpoints.base_url') + Util::Config.get('endpoints.profile')
+          url = build_url(url, params)
+          payload = profile.to_json
+          response = RestClient.post(url, payload, get_headers())
+          Components::Profile.create(JSON.parse(response.body)["data"])
+        end
+
+        # more info - http://docs.crowdskout.com/api/#create-many-profiles
+        def create_profiles_bulk(profiles)
+          raise Exceptions::ServiceException, "Must be an array of profiles." if profiles.nil? || !profiles.is_a?(Array)
+          url = Util::Config.get('endpoints.base_url') + Util::Config.get('endpoints.profile_bulk')
+          url = build_url(url)
+          payload = profiles.to_json
+          response = RestClient.post(url, payload, get_headers())
+          body = JSON.parse(response.body)
+
+          profiles = []
+          body['data'].each do |profile|
+            profiles << Components::Profile.create(profile)
+          end if body['data'].count > 0
+
+          Components::ResultSet.new(profiles, body['messages'])
+        end
+
+        # more info - http://docs.crowdskout.com/api/#update-a-profile-by-id
+        def update_profile(profile)
+          raise Exceptions::ServiceException, "Profile object must not be nil." if profile.nil?
+          url = Util::Config.get('endpoints.base_url') + sprintf(Util::Config.get('endpoints.crud_profile'), profile.id)
+          url = build_url(url)
+          payload = profile.to_json
+          response = RestClient.put(url, payload, get_headers())
+          Components::Profile.create(JSON.parse(response.body)["data"])
+        end
+
+        # more info - http://docs.crowdskout.com/api/#update-many-profiles
+        def update_profiles_bulk(profiles)
+          raise Exceptions::ServiceException, "Must be an array of profiles." if profiles.nil? || !profiles.is_a?(Array)
+          url = Util::Config.get('endpoints.base_url') + Util::Config.get('endpoints.profile_bulk')
+          url = build_url(url)
+          payload = profiles.to_json
+          response = RestClient.put(url, payload, get_headers())
+          body = JSON.parse(response.body)
+
+          profiles = []
+          body['data'].each do |profile|
+            profiles << Components::Profile.create(profile)
+          end if body['data'].count > 0
+
+          Components::ResultSet.new(profiles, body['messages'])
+        end
+      end
+    end
+  end
+end

data/lib/crowdskout/util/config.rb

@@ -0,0 +1,75 @@
+module Crowdskout
+  module Util
+    class Config
+
+      # Return a hash of configuration strings
+      # @return [Hash] - hash of configuration properties
+      @props = {
+        # REST endpoints
+        :endpoints => {
+          :base_url                       => 'https://api.crowdskout.com/v1/',
+
+          :profile                        => 'profile',
+          :crud_profile                   => 'profile/%s',
+          :profile_bulk                   => 'profile/bulk',
+
+          :fields_options                 => 'fields/%s/options',
+
+          :attributes                     => 'attributes',
+          :attribute                      => 'attribute',
+          :crud_attribute                 => 'attribute/%s'
+        },
+
+        # OAuth2 Authorization related configuration options
+        :auth => {
+          :base_url                      => 'https://api.crowdskout.com/oauth/',
+          :response_type_code            => 'code',
+          :authorization_code_grant_type => 'authorization_code',
+          :authorization_endpoint        => 'authorize',
+          :token_endpoint                => 'access_token',
+          :api_key                       => '',
+          :api_secret                    => '',
+          :redirect_uri                  => ''
+        },
+
+        # Errors to be returned for various exceptions
+        :errors => {
+          :api_key_missing      => 'api_key required either explicitly or in configuration.',
+          :access_token_missing => 'access_token required explicitly.',
+          :api_secret_missing   => 'The api_secret is missing in explicit call or configuration.'
+        }
+      }
+
+      class << self
+        attr_accessor :props
+
+         def configure 
+          yield props if block_given?
+        end
+
+        # Get a configuration property given a specified location, example usage: Config::get('auth.token_endpoint')
+        # @param [String] index - location of the property to obtain
+        # @return [String]
+        def get(index)
+          properties = index.split('.')
+          get_value(properties, props)
+        end
+
+        private
+
+        # Navigate through a config array looking for a particular index
+        # @param [Array] index The index sequence we are navigating down
+        # @param [Hash, String] value The portion of the config array to process
+        # @return [String]
+        def get_value(index, value)
+          index = index.is_a?(Array) ? index : [index]
+          key = index.shift.to_sym
+          value.is_a?(Hash) and value[key] and value[key].is_a?(Hash) ?
+          get_value(index, value[key]) :
+          value[key]
+        end
+      end
+
+    end
+  end
+end

data/lib/crowdskout/util/helpers.rb

@@ -0,0 +1,21 @@
+module Crowdskout
+  module Util
+    class Helpers
+      class << self
+
+        # Build the HTTP query from the given parameters
+        # @param [Hash] params
+        # @return [String] query string
+        def http_build_query(params)
+          params.collect{ |k,v| "#{k.to_s}=#{encode(v.to_s)}" }.reverse.join('&')
+        end
+
+        # Escape special characters
+        # @param [String] str
+        def encode(str)
+          CGI.escape(str).gsub('.', '%2E').gsub('-', '%2D')
+        end
+      end
+    end
+  end
+end

data/lib/crowdskout/version.rb

@@ -0,0 +1,23 @@
+# 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.
+
+module Crowdskout
+  VERSION = '0.0.4'
+end

data/spec/crowdskout/auth/oauth2_spec.rb

@@ -0,0 +1,114 @@
+ #
+# oauth2_spec.rb
+# Crowdskout
+#
+# Copyright (c) 2016 Kyle Schutt. All rights reserved.
+
+require 'spec_helper'
+
+describe Crowdskout::Auth::OAuth2 do
+
+  before(:all) {
+    Crowdskout::Util::Config.configure do |config|
+      config[:auth].delete :api_key
+      config[:auth].delete :api_secret
+      config[:auth].delete :redirect_uri
+    end
+  }
+
+  describe "#new" do
+    it "fails without arguments and no configuration" do
+      lambda {
+        Crowdskout::Auth::OAuth2.new
+      }.should raise_error(ArgumentError)
+    end
+
+    it "takes one argument" do
+      opts = {:api_key => 'api key', :api_secret => 'secret', :redirect_url => 'redirect url'}
+      lambda {
+        Crowdskout::Auth::OAuth2.new(opts)
+      }.should_not raise_error
+    end
+  end
+
+  context "with middle-ware configuration" do
+    before(:all) do
+      Crowdskout::Util::Config.configure do |config|
+        config[:auth][:api_key] = "config_api_key"
+        config[:auth][:api_secret] = "config_api_secret"
+        config[:auth][:redirect_uri] = "config_redirect_uri"
+      end
+    end
+    let(:proc) { lambda { Crowdskout::Auth::OAuth2.new } }
+    it "without error" do
+      proc.should_not raise_error
+    end
+    let(:oauth) { proc.call }
+    it "has correct api_key" do
+      oauth.client_id.should == "config_api_key"
+    end
+    it "has correct api_secret" do
+      oauth.client_secret.should == "config_api_secret"
+    end
+    it "has correct redirect_uri" do
+      oauth.redirect_uri.should == "config_redirect_uri"
+    end
+  end
+
+  context "with middle-ware configuration and explicit opts" do
+    before(:all) do
+      Crowdskout::Util::Config.configure do |config|
+        config[:auth][:api_key] = "config_api_key"
+        config[:auth][:api_secret] = "config_api_secret"
+        config[:auth][:redirect_uri] = "config_redirect_uri"
+      end
+    end
+    let(:proc) { lambda { Crowdskout::Auth::OAuth2.new :api_key => 'explicit_api_key', :api_secret => 'explicit_api_secret', :redirect_url => 'explicit_redirect_uri' } }
+    it "without error" do
+      proc.should_not raise_error
+    end
+    let(:oauth) { proc.call }
+    it "has correct api_key" do
+      oauth.client_id.should == "explicit_api_key"
+    end
+    it "has correct api_secret" do
+      oauth.client_secret.should == "explicit_api_secret"
+    end
+    it "has correct redirect_uri" do
+      oauth.redirect_uri.should == "explicit_redirect_uri"
+    end
+  end
+
+  it "with explicit arguments and no configuration" do
+    lambda {
+      Crowdskout::Auth::OAuth2.new  :api_key => "api_key", :api_secret => "api_secret", :redirect_url => "redirect_uri"
+    }.should_not raise_error
+  end
+
+  let(:proc) { lambda { Crowdskout::Auth::OAuth2.new(:api_key => "api_key", :api_secret => "api_secret", :redirect_url => "redirect_uri") } }
+  let(:oauth) { proc.call }
+
+  describe "#get_authorization_url" do
+    it "returns a string" do
+      oauth.get_authorization_url.should be_kind_of(String)
+      oauth.get_authorization_url('my_param').should match('state=my_param')
+    end
+  end
+
+  describe "#get_access_token" do
+    it "returns a Hash" do
+      json = load_file('access_token.json')
+      RestClient.stub(:post).and_return(json)
+      oauth.get_access_token('token').should be_kind_of(Hash)
+    end
+
+    it "throws an OAuth2Exception in case of error" do
+      json = load_file('access_token_error.json')
+      RestClient.stub(:post).and_return(json)
+      lambda {
+        oauth.get_access_token('token')
+      }.should raise_exception(Crowdskout::Exceptions::OAuth2Exception, 
+        'The resource owner or authorization server denied the request.')
+    end
+  end
+end