simplewoo 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9ce5ee64a12d9b4dba315dfb6befedb743d7d956
+  data.tar.gz: 561cd207dea0eea08a393a7b0d6faa3f16e1d677
+SHA512:
+  metadata.gz: b294c8dce8d1d0106f9ca4b97c6585d1fb8e22134ddea2c6e9d8757258bc237450613d4c92b0e683ffb4a40014e09cbbd654d1e0c7e3c7a8e8aa201d1183f1e9
+  data.tar.gz: 2fdbbdc9fa747de48bb6e08366d5bc13930ff4df48c03586979b895b775b6f78dbcb5c5c107e44413f9fe1341a4feeb2ddc7f73aa31ee4ec5bce617ed8734811

data/.gitignore

@@ -0,0 +1,17 @@
+*.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/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in simplewoo.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jason Truluck
+
+MIT License
+
+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.

data/README.md

@@ -0,0 +1,29 @@
+# Simplewoo
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'simplewoo'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simplewoo
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/simplewoo/authentication.rb

@@ -0,0 +1,35 @@
+# lib/simplewoo/authentication.rb
+module Simplewoo
+  module Authentication
+    def basic_authenticated?
+      !!(self.email && self.password)
+    end
+
+    def token_authenticated?
+      !!(self.api_token)
+    end
+
+    def authenticated?
+      !!(basic_authenticated? || token_authenticated?)
+    end
+
+    def api_token
+      self.api_token ||= authenticate if authenticated?
+    end
+
+    # Authenticates the user with their email and password returning an api token
+    #
+    # @option args [String] email - the email of the user
+    # @option args [String] password - the password of the user
+    def authenticate(args = {})
+      self.email ||= args.delete(:email)
+      self.password ||= args.delete(:password)
+
+      unless token_authenticated?
+        self.api_token = me.access_token
+      end
+
+      self.api_token
+    end
+  end
+end

data/lib/simplewoo/client/entity.rb

@@ -0,0 +1,32 @@
+module Simplewoo
+  class Client
+    module Entity
+      # Returns the matched entities for the slider
+      #
+      # @param [Integer] slider_id - The slider id that the entities are for
+      # @param [Integer] page_id   - The page id that the entities are for
+      #
+      # @return [Hashie::Mash] Entities - list of entities by page
+      #
+      # @author Tom Prats
+      # Simplewoo::Client.entities(1)
+      def entities(slider_id, page_id=1, options = {})
+        get("/sliders/#{slider_id}/entities/page/#{page_id}", options)
+      end
+
+      # Returns matched the entity
+      #
+      # @param [Integer] slider_id - The slider id that the entity is for
+      # @param [Integer] entity_id - The entity id that the entity is for
+      #
+      # @return [Hashie::Mash] Entity - the entity requested
+      #
+      # @author Tom Prats
+      # Simplewoo::Client.entity(1, 1)
+      def entity(slider_id, entity_id, options = {})
+        get("/sliders/#{slider_id}/entities/#{entity_id}", options)
+      end
+    end
+  end
+end
+

data/lib/simplewoo/client/match.rb

@@ -0,0 +1,20 @@
+module Simplewoo
+  class Client
+    module Match
+      # Returns the matched entities and matched personalities for the slider
+      #
+      # @param [Integer] id - The slider id that the matches are for
+      #
+      # @return [Hashie::Mash] matches - the matches for the slider
+      #
+      # @example Return the entity matches for a slider
+      #   Simplewoo::Client.match_for_slider(1).entities
+      # @example Return the personality matches for a slider
+      #   Simplewoo::Client.match_for_slider(1).personalities
+      def match_for_slider(id, options = {})
+        get("/sliders/#{id}/results", options)._embedded
+      end
+    end
+  end
+end
+

data/lib/simplewoo/client/personality.rb

@@ -0,0 +1,31 @@
+
+module Simplewoo
+  class Client
+    module Personality
+      # Returns the personalities for the slider
+      #
+      # @param [Integer] id - The slider id that the matches are for
+      #
+      # @return [Hashie::Mash] personalities - the personalities for the slider
+      #
+      # @example Return the personalities for a slider
+      #   Simplewoo::Client.personality_for_slider(1)
+      def personality_for_slider(id, options = {})
+        get("/sliders/#{id}/results", options)._embedded.personalities
+      end
+
+      # Resets the slider
+      #
+      # @param [Integer] id - The slider id that is reset
+      #
+      # @return status only
+      #
+      # @example Return the personalities for a slider
+      #   Simplewoo::Client.personality_for_slider(1)
+      def reset(id, options = {})
+        delete("/sliders/#{id}/reset", options)
+      end
+    end
+  end
+end
+

data/lib/simplewoo/client/root.rb

@@ -0,0 +1,10 @@
+module Simplewoo
+  class Client
+    module Root
+      def root(options = {})
+        get("/", options)
+      end
+    end
+  end
+end
+

data/lib/simplewoo/client/slider.rb

@@ -0,0 +1,32 @@
+module Simplewoo
+  class Client
+    module Slider
+      # Return the sliders for the app you are on
+      #
+      # @note requires an authenticated Client instance (app_secret) _not_ an authenticated user
+      #
+      # @return [Hashie::Mash] sliders - the sliders available for the app
+      #
+      # @example  Return the sliders for an app
+      #   Simplewoo::Client.sliders
+      def sliders(options = {})
+        get("/sliders", options)
+      end
+
+      # Return the requested slider and its associated tags
+      #
+      # @note requires an authenticated Client instance (app_secret) _not_ an authenticated user
+      #
+      # @param [Integer] id - the id of the slider that you want to have returned
+      #
+      # @return [Hashie::Mash] slider - the slider that was requested 
+      #
+      # @example Return a slider
+      #   Simplewoo::Client.slider(1)
+      def slider(id, options = {})
+        get("/sliders/#{id}", options)
+      end
+    end
+  end
+end
+

data/lib/simplewoo/client/tag.rb

@@ -0,0 +1,32 @@
+module Simplewoo
+  class Client
+    module Tag
+      # Returns the matched entities and matched personalities for the slider
+      #
+      # @param [Integer] slider_id - The slider id that the matches are for
+      # @param [Integer] tag_id - The tag id that the matches are for
+      # @param [Boolean] value - The tag id that the matches are for
+      #
+      # @author Carson Wright
+      # @author Chris Preisinger
+      # Simplewoo::Client.add_tag(1, 1, true)
+      def add_tag(slider_id, tag_id, value, options = {})
+        options.merge!(me: value)
+        post("/sliders/#{slider_id}/tags/#{tag_id}/add", options)
+      end
+
+      # Returns a tag
+      #
+      # @param [Integer] tag_id - The tag id you want returned 
+      #
+      # @return [Hashie::Mash] Tag - the requested tag
+      #
+      # @author Carson Wright
+      # Simplewoo::Client.tag(1, 1, true)
+      def tag(tag_id, options = {})
+        get("/tags/#{tag_id}", options)
+      end
+    end
+  end
+end
+

data/lib/simplewoo/client/user.rb

@@ -0,0 +1,87 @@
+module Simplewoo
+  class Client
+    module User
+      # Create a user on the core api
+      #
+      # @param [String] email - the email of the user
+      # @param [String] password - the password of the user
+      # @param [String] password_confirmation - the password_confirmation of the user
+      # @param [String] birthday - the birthday of the user
+      # @param [String] first_name - the first name of the user
+      # @param [String] last_name - the first name of the user
+      #
+      # @option options [String] bio - The users bio
+      # @option options [String] image - The users image
+      #
+      # @return [Hashie::Mash] user the user created by the request
+      #
+      # @example Create a user
+      #   Simplewoo.create_user({
+      #     :email => "some@example.com",
+      #     :password => "password",
+      #     :password_confirmation => "password",
+      #     :birthday => "1988-01-01",
+      #     :first_name => "Johnny",
+      #     :last_name => "Test"
+      #   })
+      def create_user(email, password, password_confirmation, birthday, first_name, last_name, options = {})
+        options.merge!({
+          :email                 => email,
+          :password              => password,
+          :password_confirmation => password_confirmation,
+          :birthday              => birthday,
+          :first_name            => first_name,
+          :last_name             => last_name
+        })
+
+        result = post("/users", { :user => options })
+        # TODO we should really make this core method return an api_token as well and use that instead
+        authenticate({:email => email, :password => password })
+        result
+      end
+
+      # Update a user on the core api
+      #
+      # @note This method requires an authenticated user via email + password or api_token
+      #
+      # @option options [String] email - the email of the user
+      # @option options [String] password - the password of the user
+      # @option options [String] password_confirmation - the password_confirmation of the user
+      # @option options [String] birthday - the birthday of the user
+      # @option options [String] first_name - the first name of the user
+      # @option options [String] last_name - the first name of the user
+      # @option options [String] bio - The users bio
+      # @option options [String] image - The users image
+      #
+      # @return [Hashie::Mash] user the user updated by the request
+      #
+      # @example Update a user
+      #   Simplewoo.update_user({
+      #     :email => "some_new_email@example.com"
+      #   })
+      def update_user(options = {})
+        if authenticated?
+          put("/users/me", { :user => options })
+        else
+          raise "No authorized user."
+        end
+      end
+      alias :reset_password :update_user
+
+      # Returns the currently authenticated user
+      #
+      # @note This method requires an authenticated user via email + password or api_token
+      #
+      # @example Return the user
+      #  Simplewoo.me
+      def me
+        if authenticated?
+          get("/users/me")
+        else
+          raise "No authorized user."
+        end
+      end
+    end
+  end
+end
+

data/lib/simplewoo/client.rb

@@ -0,0 +1,33 @@
+# lib/simplewoo/client.rb
+# require base modules
+require "simplewoo/authentication"
+require "simplewoo/connection"
+require "simplewoo/request"
+# require client modules in lib/simplewoo/client
+Dir[File.expand_path("../client/*.rb", __FILE__)].each {|f| require f }
+
+module Simplewoo
+  class Client
+    attr_accessor(*Configuration::VALID_OPTIONS_KEYS)
+
+    def initialize(options = {})
+      options = Simplewoo.options.merge(options)
+
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        send("#{key}=", options[key])
+      end
+    end
+
+    include Simplewoo::Authentication
+    include Simplewoo::Connection
+    include Simplewoo::Request
+
+    include Simplewoo::Client::Root
+    include Simplewoo::Client::User
+    include Simplewoo::Client::Slider
+    include Simplewoo::Client::Match
+    include Simplewoo::Client::Personality
+    include Simplewoo::Client::Tag
+    include Simplewoo::Client::Entity
+  end
+end

data/lib/simplewoo/configuration.rb

@@ -0,0 +1,34 @@
+# lib/simplewoo/configuration.rb#
+module Simplewoo
+  module Configuration
+    # TODO try to remove redis
+    VALID_OPTIONS_KEYS = [
+      :app_secret,
+      :api_server_host,
+      :api_endpoint,
+      :trusted,
+      :ssl,
+      :email,
+      :password,
+      :api_token,
+      :debug
+    ]
+
+    attr_accessor(*VALID_OPTIONS_KEYS)
+
+    def configure
+      yield self
+    end
+
+    def options
+      VALID_OPTIONS_KEYS.inject({}){|o,k| o.merge!(k => send(k)) }
+    end
+
+    def reset!
+      VALID_OPTIONS_KEYS.each {|key| class_eval(%Q{key = nil}) }
+      self.trusted = "false"
+      self.ssl = true
+      self.debug = false
+    end
+  end
+end

data/lib/simplewoo/connection.rb

@@ -0,0 +1,69 @@
+# lib/simplewoo/connection.rb
+require "json"
+require "faraday_middleware"
+require "simplewoo/error"
+require "pry"
+
+module Simplewoo
+  module Connection
+    def connection(options = {})
+      connection ||= Faraday.new(options) do |faraday|
+        faraday.request :url_encoded
+        if basic_authenticated?
+          faraday.request :basic_auth, self.email, self.password
+        elsif token_authenticated?
+          faraday.request :basic_auth, "", self.api_token
+        end
+        faraday.use AppSecretMiddleware, app_secret: self.app_secret
+        faraday.use TrustedAppMiddleware, trusted: self.trusted
+        faraday.response :logger if self.debug
+        faraday.use ErrorMiddleware
+        faraday.response :mashify
+        faraday.response :json, :content_type => /\bjson$/
+        faraday.adapter Faraday.default_adapter
+      end
+
+      connection
+    end
+
+    private
+    # Middleware for inserting the app secret header into requests
+    class AppSecretMiddleware < Faraday::Middleware
+      def initialize(app, options = {})
+        @app = app
+        @options = options
+      end
+
+      def call(env)
+        env[:request_headers]["Woofound-App-Secret"] = @options[:app_secret]
+        @app.call(env)
+      end
+    end
+    # Middleware for inserting the trusted header into requests
+    class TrustedAppMiddleware < Faraday::Middleware
+      def initialize(app, options = {})
+        @app = app
+        @options = options
+      end
+
+      def call(env)
+        env[:request_headers]["Woofound-Use-Trusted"] = @options[:trusted].to_s
+        @app.call(env)
+      end
+    end
+    # Middleware for responding to Errors returned from the api
+    class ErrorMiddleware < Faraday::Middleware
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        @app.call(env).on_complete do |env|
+          if error = Simplewoo::Error.from(env[:response])
+            raise error
+          end
+        end
+      end
+    end
+  end
+end

data/lib/simplewoo/error.rb

@@ -0,0 +1,47 @@
+# lib/simplewoo/error.rb
+module Simplewoo
+  class Error < StandardError
+    attr_accessor :response
+
+    def self.from(response)
+      status  = response.status
+
+      if klass = case status
+                 when 400 then Simplewoo::BadRequest
+                 when 401 then Simplewoo::Unauthorized
+                 when 404 then Simplewoo::NotFound
+                 when 422 then Simplewoo::UnprocessableEntity
+                 end
+
+      klass.new(response)
+      end
+    end
+
+    def initialize(response)
+      @response = response
+      super(error_message)
+    end
+
+    def errors
+      response.body
+    end
+
+    private
+    def error_message
+      message =  "#{response.env[:method].upcase} "
+      message << "#{response.env[:url].to_s} | "
+      message << "#{response.status}: "
+      message << "#{response.body.map{|k,v| "#{k}: #{v.first}"}.join(", ")}"
+      message
+    end
+  end
+
+  # Raised when Woofound Core Api returns a 400 HTTP status code
+  class BadRequest < Error; end
+  # Raised when Woofound Core Api returns a 401 HTTP status code
+  class Unauthorized < Error; end
+  # Raised when Woofound Core Api returns a 404 HTTP status code
+  class NotFound < Error; end
+  # Raised when Woofound Core Api returns a 422 HTTP status code
+  class UnprocessableEntity < Error; end
+end

data/lib/simplewoo/request.rb

@@ -0,0 +1,54 @@
+# lib/simplewoo/request.rb
+module Simplewoo
+  module Request
+    def get(path, options = {})
+      request(:get, path, options)
+    end
+
+    def post(path, options = {})
+      request(:post, path, options)
+    end
+
+    def put(path, options={})
+      request(:put, path, options)
+    end
+
+    def delete(path, options={})
+      request(:delete, path, options)
+    end
+
+    def last_response
+      @last_response
+    end
+
+    private
+    def build_endpoint
+      endpoint = ssl ? "https://" : "http://"
+      endpoint << self.api_server_host
+      self.api_endpoint = endpoint
+    end
+
+    def request(method, path, options = {})
+      url     = options.delete(:endpoint) || build_endpoint
+
+      connection_options = {}.merge!(:url => url)
+
+      response = connection(connection_options).send(method) do |request|
+        case method
+        when :get
+          request.url(path, options)
+        when :post
+          request.url(path, options)
+        when :put
+          request.url(path, options)
+        when :delete
+          request.url(path, options)
+        end
+      end
+
+      @last_response = response
+      response.body
+    end
+  end
+end
+

data/lib/simplewoo/version.rb

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

data/lib/simplewoo.rb

@@ -0,0 +1,14 @@
+require "simplewoo/version"
+require "simplewoo/configuration"
+require "simplewoo/client"
+
+module Simplewoo
+  extend Configuration
+
+  class << self
+    # Alias method for Simplewoo::Client.new
+    def new(options = {})
+      Simplewoo::Client.new(options)
+    end
+  end
+end

data/simplewoo.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simplewoo/version'
+
+Gem::Specification.new do |spec|
+    spec.name          = "simplewoo"
+    spec.version       = Simplewoo::VERSION
+    spec.authors       = ["Jason Truluck", "Carson Wright", "Tom Prats", "Sam Boyd", "Chris Preisinger"]
+    spec.email         = ["jason.truluck@gmail.com", "carsonnwright@gmail.com", "tom@tomprats.com", "sam@woofound.com", "chris@woofound.com"]
+    spec.description   = %q{Woofound Client Gem}
+    spec.summary       = spec.description
+    spec.homepage      = ""
+    spec.license       = "MIT"
+
+    spec.files         = `git ls-files`.split($/)
+    spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+    spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+    spec.require_paths = ["lib"]
+
+    spec.add_dependency "faraday", "~> 0.8.0"
+    spec.add_dependency "faraday_middleware", "~> 0.9.0"
+    spec.add_dependency "hashie", "~> 2.0.0"
+    spec.add_dependency "multi_json", "~> 1.8.0"
+
+    spec.add_development_dependency "bundler", "~> 1.3"
+    spec.add_development_dependency "rake", "~> 10.1.0"
+    spec.add_development_dependency "rspec", "~> 2.14.0"
+    spec.add_development_dependency "pry"
+    spec.add_development_dependency "binding_of_caller"
+    spec.add_development_dependency "webmock", "~> 1.13.0"
+    spec.add_development_dependency "simplecov", "~> 0.7.0"
+    spec.add_development_dependency "coveralls", "~> 0.7.0"
+    spec.add_development_dependency "yard", "~> 0.8.0.0"
+    spec.add_development_dependency "redcarpet", "~> 3.0.0"
+end
+