awardflair 0.0.1

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/.rvmrc

@@ -0,0 +1,48 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
+# Only full ruby name is supported here, for short names use:
+#     echo "rvm use 1.9.3" > .rvmrc
+environment_id="ruby-1.9.3-p194@pickflair"
+
+# Uncomment the following lines if you want to verify rvm version per project
+# rvmrc_rvm_version="1.15.8 (master)" # 1.10.1 seams as a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+  [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]] &&
+    \. "${rvm_path:-$HOME/.rvm}/hooks/after_use" || true
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create  "$environment_id" || {
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  }
+fi
+
+# If you use bundler, this might be useful to you:
+# if [[ -s Gemfile ]] && {
+#   ! builtin command -v bundle >/dev/null ||
+#   builtin command -v bundle | GREP_OPTIONS= \grep $rvm_path/bin/bundle >/dev/null
+# }
+# then
+#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
+#   gem install bundler
+# fi
+# if [[ -s Gemfile ]] && builtin command -v bundle >/dev/null
+# then
+#   bundle install | GREP_OPTIONS= \grep -vE '^Using|Your bundle is complete'
+# fi

data/.rvmrc.12.27.2012-19:48:12

@@ -0,0 +1,48 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
+# Only full ruby name is supported here, for short names use:
+#     echo "rvm use 1.9.3" > .rvmrc
+environment_id="ruby-1.9.3-p194"
+
+# Uncomment the following lines if you want to verify rvm version per project
+# rvmrc_rvm_version="1.15.8 (master)" # 1.10.1 seams as a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+  [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]] &&
+    \. "${rvm_path:-$HOME/.rvm}/hooks/after_use" || true
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create  "$environment_id" || {
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  }
+fi
+
+# If you use bundler, this might be useful to you:
+# if [[ -s Gemfile ]] && {
+#   ! builtin command -v bundle >/dev/null ||
+#   builtin command -v bundle | GREP_OPTIONS= \grep $rvm_path/bin/bundle >/dev/null
+# }
+# then
+#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
+#   gem install bundler
+# fi
+# if [[ -s Gemfile ]] && builtin command -v bundle >/dev/null
+# then
+#   bundle install | GREP_OPTIONS= \grep -vE '^Using|Your bundle is complete'
+# fi

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Matt Lally
+
+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,50 @@
+# Awardflair
+
+Award flair (badges) to people using your app via the free PickFlair service (http://www.pickflair.com)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'awardflair'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install awardflair
+
+## Usage
+
+    # Connect to your PickFlair account
+    pf = PickFlair.new(api_key, api_secret, application_id)
+
+    # Get a list of all the badges you have created on PickFlair
+    pf.collect_badges
+
+    # If you have already collected badges, this just gets that list again.  If you haven't, it collects them for the first time
+    pf.badges
+
+    # Get badge information using badge identifier
+    pf.get_badge_by_identifier(badge_identifier)
+
+    # Find a specific badge that you know you have created using it's name.
+    pf.find_badges("Ruby Ace")
+
+    # Award a badge via a link that you can provide to the recipient
+    ruby_ace_badge = pf.find_badges("Ruby Ace").first # Choosing the first (and probably only) badge you have named "Ruby Ace"
+    ruby_ace_badge.award # Returns a link that you can show to recipient so they can claim the badge.  
+
+    # Award a badge by email (also gets you a link that you can give to the user.)
+    first_badge = pf.badges.first # Getting the first badge you created.
+    first_badge.award_to("email_address@mydomain.com")
+
+## 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,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/awardflair.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'awardflair/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "awardflair"
+  gem.version       = Awardflair::VERSION
+  gem.authors       = ["Matt Lally"]
+  gem.email         = ["shinsyotta@gmail.com"]
+  gem.description   = %q{Award flair (badges) to users of your app using the PickFlair service.}
+  gem.summary       = %q{A gem for awarding badges via PickFlair.}
+  gem.homepage      = "http://www.awardflair.com"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+
+  gem.add_development_dependency 'rake' 
+  gem.add_development_dependency 'rspec'
+
+  gem.add_runtime_dependency 'httparty'
+end

data/lib/awardflair/pickflair_api.rb

@@ -0,0 +1,106 @@
+require 'httparty'
+# require 'yajl/yajl'
+
+class PFBadge
+  attr_accessor :id, :name, :description, :picture_url, :pickflair_instance
+
+  def initialize(attributes={})
+    attributes.each do |key, value|
+      instance_variable_set("@#{key}", value) unless value.nil?
+    end
+  end
+
+  def qualify?(search_terms)
+    search_terms.each do |key, value|
+      if value == self.send(key.to_sym)
+        self
+      else
+        return false && break
+      end
+    end
+  end
+
+  def award
+    pickflair_instance.award_badge(@id)
+  end
+
+  def award_to(email_of_recipient)
+    pickflair_instance.award_badge_by_email(@id, email_of_recipient)
+  end
+end
+
+class PickFlair
+  
+  include HTTParty
+  attr_accessor :badges
+  
+  def initialize(api_key, api_secret, application_id)
+    @badges ||= []
+    self.class.base_uri 'https://www.pickflair.com/api/v1'
+    self.class.default_params :output => 'json'; self.class.format :json
+    @auth = {:api_key => api_key, :api_secret => api_secret, :application_id => application_id}
+  end
+
+  def collect_badges
+    @badges = []
+    array_of_badges_from_api.each do |badge_hash|
+      @badges << PFBadge.new(badge_hash.merge(:pickflair_instance => self))
+    end
+    @badges
+  end
+
+  def badges
+    if @badges.any?
+      @badges
+    else
+      collect_badges
+    end
+  end
+
+  def find_badges(search_terms)
+    badges.select {|badge| badge.qualify?(search_terms)}
+  end
+
+  def award_badge(badge_identifier)
+    api_response = self.class.post("/badge_request_logs.json", :body => token.merge(:badge_id => badge_identifier))
+    api_response.parsed_response["data"]["badge_awarding_url"]
+  end
+
+  def award_badge_by_email(badge_identifier, email_of_recipient)
+    api_response = self.class.post("/email_awards.json", :body => token.merge(:badge_id => badge_identifier, :email => email_of_recipient))
+    api_response.parsed_response["data"]["badge_award_url"]
+  end
+
+  def get_badge_by_identifier(badge_identifier)
+    badges_that_match = find_badges(:id => badge_identifier)
+    if badges_that_match.any?
+      badges_that_match.first
+    else
+      api_response = self.class.get("/badges/#{badge_identifier}.json", :body => token)
+      api_response.parsed_response["data"]
+    end
+  end
+
+  private
+
+  def login
+    response = self.class.post("/logins.json", :body => @auth)
+    @token = response["data"]["token"]
+  end
+
+  def token
+    { :token => (@token || login) }
+  end
+
+  def array_of_badges_from_api
+    api_response = self.class.get("/badges.json", :body => token)
+    api_response.parsed_response["data"]["flair"]
+  end
+
+  # def find(search_terms = {})
+  #   array_of_badges_from_api.select do |badge_from_api|
+  #     badge_from_api[]
+  #   end
+  # end
+
+end

data/lib/awardflair/version.rb

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

data/lib/awardflair.rb

@@ -0,0 +1,6 @@
+require "awardflair/version"
+require 'awardflair/pickflair_api.rb'
+
+# module Awardflair
+#   # Your code goes here...
+# end

data/spec/lib/awardflair_spec.rb

@@ -0,0 +1,7 @@
+require 'awardflair'
+
+describe PickFlair do 
+    it "should return an array of badges belonging to the logged in business" do 
+        
+    end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'awardflair'

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: awardflair
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Matt Lally
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Award flair (badges) to users of your app using the PickFlair service.
+email:
+- shinsyotta@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- .rvmrc.12.27.2012-19:48:12
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- awardflair.gemspec
+- lib/awardflair.rb
+- lib/awardflair/pickflair_api.rb
+- lib/awardflair/version.rb
+- spec/lib/awardflair_spec.rb
+- spec/spec_helper.rb
+homepage: http://www.awardflair.com
+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'
+      segments:
+      - 0
+      hash: -592585161258406128
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -592585161258406128
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A gem for awarding badges via PickFlair.
+test_files:
+- spec/lib/awardflair_spec.rb
+- spec/spec_helper.rb