fleetly 0.0.3

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+spec/cassettes

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format documentation
+--tty

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Julius Francisco
+
+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,43 @@
+# Fleetly
+
+API Wrapper for [Fleetly](http://www.fleetly.com/api/docs/quickstart)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+    gem 'fleetly'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fleetly
+
+## Usage
+
+```ruby
+require 'fleetly'
+
+Fleetly.configure do |config|
+  config.api_url = 'https://api.fleetly.com'
+  config.token = 'your-token-here'
+end
+
+client = Fleetly::Client.new
+
+activity = client.get_activity(<ACTIVITY_ID>) #=> returns a Mash of Activity
+
+```
+
+## 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/fleetly.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fleetly/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fleetly"
+  spec.version       = Fleetly::VERSION
+  spec.authors       = ["Julius Francisco & Jay Balanay"]
+  spec.email         = ["baldrailers@gmail.com & manolet.balanay@gmail.com"]
+  spec.description   = %q{API Wrapper for Fleetly}
+  spec.summary       = spec.description
+  spec.homepage      = "http://www.motivationscience.com"
+  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'
+  spec.add_dependency 'faraday_middleware', '~> 0.9'
+  spec.add_dependency 'hashie', '~> 2.0.3'
+  spec.add_dependency 'activesupport'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "simplecov-rcov"
+  spec.add_development_dependency "yard"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "shoulda"
+  spec.add_development_dependency "webmock"
+end

data/lib/fleetly.rb

@@ -0,0 +1,31 @@
+require "faraday"
+require "faraday_middleware"
+require "fleetly/version"
+require "fleetly/client"
+
+directory = File.expand_path(File.dirname(__FILE__))
+
+module Fleetly
+
+  class << self
+    attr_accessor :api_url, :token
+
+    ##
+    # Configure default
+    #
+    # @yield [Fleetly]
+    def configure
+      load_defaults
+      yield self
+      true
+    end
+
+    private
+
+    def load_defaults
+      self.api_url ||= 'https://www.fleetly.com'
+      self.token ||= 'ANONYMOUS_OAUTH_TOKEN'
+    end
+  end
+
+end

data/lib/fleetly/activity.rb

@@ -0,0 +1,39 @@
+# encoding: utf-8
+
+module Fleetly
+  module Activity
+
+    ##
+    # Retrieve Activity details given the ID
+    #
+    # @param :id [String] Activity ID
+    #
+    # @return [Hashie::Mash] Activity
+    def get_activity(id)
+      options = {}
+      options[:oauth_token] = token
+      activity_response = get("/api/v1/activities/#{id}", options)
+
+      activity_response if activity_response.result?
+    end
+
+    ##
+    # Retrieve Activities
+    #
+    # @param :name [String] Name to match
+    # @param :type [String] Type of Activity
+    # @param :start [Integer] Desired starting point
+    # @param :limit [Integer] Maximum number of result
+    # @param :order [String] Order of result
+    #
+    # @return [Hashie::Mash] Activity
+    def get_activities(options={})
+      options = {}
+      options[:oauth_token] = token
+      activity_response = get("/api/v1/activities/search", options)
+
+      activity_response if activity_response.result?
+    end
+
+  end
+end

data/lib/fleetly/client.rb

@@ -0,0 +1,52 @@
+# encoding: utf-8
+require 'forwardable'
+require 'fleetly/request'
+require 'fleetly/user'
+require 'fleetly/activity'
+require 'fleetly/logitem'
+
+module Fleetly
+  class Client
+    extend Forwardable
+
+    include Request
+    include User
+    include Activity
+    include Logitem
+
+    attr_reader :api_url, :token
+
+    ##
+    # Create a new Fleetly::Client object
+    #
+    # @params options[Hash]
+    def initialize(options={})
+      @api_url = options[:api_url] || Fleetly.api_url
+      @token = options[:token] || Fleetly.token
+    end
+
+    ##
+    # Create a Faraday::Connection object
+    #
+    # @return [Faraday::Connection]
+    def connection
+      params = {}
+      @connection = Faraday.new(url: api_url, params: params, headers: default_headers) do |faraday|
+        faraday.use FaradayMiddleware::Mashify
+        faraday.use FaradayMiddleware::ParseJson, content_type: /\bjson$/
+        faraday.use FaradayMiddleware::FollowRedirects
+        faraday.adapter Faraday.default_adapter
+      end
+    end
+
+    private
+
+    def default_headers
+      headers = {
+        accept: 'application/json',
+        content_type: 'application/json',
+        user_agent: "Ruby Gem by Validic #{Fleetly::VERSION}"
+      }
+    end
+  end
+end

data/lib/fleetly/logitem.rb

@@ -0,0 +1,36 @@
+# encoding: utf-8
+
+module Fleetly
+  module Logitem
+
+    ##
+    # Retrieve Logitem details given the ID
+    #
+    # @param :id [String] Logitem ID
+    #
+    # @return [Hashie::Mash] Activity
+    def get_logitem_details(id)
+      options = {}
+      options[:oauth_token] = token
+      activity_response = get("/api/v1/logitems/#{id}", options)
+
+      activity_response if activity_response.result?
+    end
+
+    ##
+    # Retrieve Logitems
+    #
+    # @param :start [Integer] Starting point (default 0)
+    # @param :limit [Integer] Max number of result (default 20)
+    #
+    # @return [Hashie::Mash] Activity
+    def get_logitems(options={})
+      options = {}
+      options[:oauth_token] = token
+      activity_response = get("/api/v1/logitems/search", options)
+
+      activity_response if activity_response.result?
+    end
+
+  end
+end

data/lib/fleetly/request.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+require 'active_support/core_ext'
+
+module Fleetly
+  module Request
+
+    def get(path, options)
+      request(:get, path, options)
+    end
+
+    def post(path, options)
+      request(:post, path, options)
+    end
+
+    def request(method, path, options)
+      response = connection.send(method) do |request|
+        case method
+        when :get
+          request.url(path, options)
+        when :put, :post
+          request.path = path
+          request.body = MultiJson.encode(options) unless options.empty?
+        end
+      end
+
+      response.body
+    end
+
+  end
+end

data/lib/fleetly/user.rb

@@ -0,0 +1,40 @@
+# encoding: utf-8
+
+module Fleetly
+  module User
+
+    ##
+    # Retrieve information about `me`
+    # associated to the `oauth_token`
+    #
+    # @param :include_activities [Integer] (1,0) `0` default
+    # @param :include_challenges [Integer] (1,0) `0` default
+    # @param :include_friends [Integer] (1,0) `0` default
+    #
+    # @return [Hashie::Mash] User
+    def me(options={})
+      options[:oauth_token] = token
+      user_me_response = get('/api/v1/users/me', options)
+
+      user_me_response if user_me_response.result?
+    end
+
+    ##
+    # Retrieve users base on search params
+    # associated to the `oauth_token`
+    #
+    # @param :name [String] 'partial name of user you want to search'
+    # @param :include_activities [Integer] (1,0) `0` default
+    # @param :include_challenges [Integer] (1,0) `0` default
+    # @param :include_friends [Integer] (1,0) `0` default
+    #
+    # @return [Hashie::Mash] User
+    def user_search(options={})
+      options[:oauth_token] = token
+      user_me_response = get('/api/v1/users/search', options)
+
+      user_me_response if user_me_response.result?
+    end
+
+  end
+end

data/lib/fleetly/version.rb

@@ -0,0 +1,3 @@
+module Fleetly
+  VERSION = "0.0.3"
+end

data/spec/fleetly/activity_spec.rb

@@ -0,0 +1,36 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe Fleetly::Activity do
+
+  let(:client) { Fleetly::Client.new }
+
+  describe "#get_activity" do
+
+    before(:each) do
+      @activity = client.get_activity('4f448458bccfee0d4701f5f0')
+    end
+
+    it "returns a Mash of Activity", vcr: true do
+      @activity.should be_kind_of Hash
+    end
+
+  end
+
+  describe "#get_activities" do
+    before(:each) do
+      options = {
+        name: "Run",
+        type: 'workout',
+        start: 1,
+        limit: 1
+      }
+      @activities = client.get_activities options
+    end
+
+    it "returns a Mash of Activities", vcr: true do
+      @activities.should be_kind_of Hash
+    end
+  end
+end
+

data/spec/fleetly/client_spec.rb

@@ -0,0 +1,11 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe Fleetly::Client do
+
+  it "creates a Faraday::Connection" do
+    client = Fleetly::Client.new
+    client.connection.should be_kind_of Faraday::Connection
+  end
+
+end

data/spec/fleetly/logitem_spec.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe Fleetly::Logitem do
+
+  let(:client) { Fleetly::Client.new }
+
+  describe "#logitem_detail" do
+
+    before(:each) do
+      @log_detail = client.get_logitem_details('5169d0ceb102f341fc6695b6')
+    end
+
+    it "returns a Mash of Logitem Details", vcr: true do
+      @log_detail.should be_kind_of Hash
+    end
+
+  end
+
+  describe "#logitem_search" do
+    before(:each) do
+      options = {
+        start: 1,
+        limit: 1
+      }
+      @logitems = client.get_logitems options
+    end
+
+    it "returns a Mash of Logitems", vcr: true do
+      @logitems.should be_kind_of Hash
+    end
+  end
+
+end
+

data/spec/fleetly/user_spec.rb

@@ -0,0 +1,44 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe Fleetly::User do
+
+  let(:client) { Fleetly::Client.new }
+
+  describe "#me" do
+    before(:each) do
+      options = {
+        include_activities: 1,
+        include_challenges: 1,
+        include_friends: 1
+      }
+      @user = client.me options
+    end
+
+    it "returns a Mash of User", vcr: true do
+      @user.should be_kind_of Hash
+    end
+
+  end
+
+  describe "#user_search" do
+    before(:each) do
+      options = {
+        name: 'Man',
+        include_activities: 1,
+        include_challenges: 1,
+        include_friends: 1,
+        limit: 1
+      }
+      @users = client.user_search options
+    end
+
+    it "returns a Mash of Users", vcr: true do
+      @users.should be_kind_of Hash
+      # @users.users.size.should eq 1
+    end
+
+  end
+
+
+end

data/spec/fleetly_spec.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe Fleetly do
+
+  let(:client) { Fleetly::Client.new }
+
+  context "configure defaults" do
+    it "uses default URL" do
+      client.api_url.should eq 'https://api.fleetly.com'
+    end
+    it "uses default TOKEN" do
+      client.token.should eq 'ANONYMOUS_OAUTH_TOKEN'
+    end
+  end
+
+  context "handles custom configurations" do
+    it "allows override of credentials" do
+      new_client = Fleetly::Client.new(api_url: 'http://localhost:3000',
+                                      token: 'MYTOKEN')
+      new_client.api_url.should eq 'http://localhost:3000'
+      new_client.token.should eq 'MYTOKEN'
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,38 @@
+require 'fleetly'
+require 'vcr'
+require 'simplecov'
+require 'simplecov-rcov'
+
+class SimpleCov::Formatter::MergedFormatter
+  def format(result)
+    SimpleCov::Formatter::HTMLFormatter.new.format(result)
+    SimpleCov::Formatter::RcovFormatter.new.format(result)
+  end
+end
+
+SimpleCov.formatter = SimpleCov::Formatter::MergedFormatter
+SimpleCov.start do
+  add_filter '/vendor'
+end
+
+VCR.configure do |c|
+  c.allow_http_connections_when_no_cassette = true
+  c.cassette_library_dir = 'spec/cassette'
+  c.hook_into :webmock
+  c.configure_rspec_metadata!
+  c.default_cassette_options = { record: :new_episodes }
+end
+
+RSpec.configure do |c|
+  c.treat_symbols_as_metadata_keys_with_true_values = true
+
+  ##
+  # Add gem specific configuration for easy access
+  #
+  c.before(:each) do
+    Fleetly.configure do |config|
+      config.api_url = 'https://api.fleetly.com'
+      config.token = 'YOUR-OAUTH-TOKEN'
+    end
+  end
+end

metadata

@@ -0,0 +1,287 @@
+--- !ruby/object:Gem::Specification
+name: fleetly
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+  prerelease: 
+platform: ruby
+authors:
+- Julius Francisco & Jay Balanay
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.3
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: simplecov
+  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: simplecov-rcov
+  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: yard
+  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: vcr
+  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: shoulda
+  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: webmock
+  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'
+description: API Wrapper for Fleetly
+email:
+- baldrailers@gmail.com & manolet.balanay@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fleetly.gemspec
+- lib/fleetly.rb
+- lib/fleetly/activity.rb
+- lib/fleetly/client.rb
+- lib/fleetly/logitem.rb
+- lib/fleetly/request.rb
+- lib/fleetly/user.rb
+- lib/fleetly/version.rb
+- spec/fleetly/activity_spec.rb
+- spec/fleetly/client_spec.rb
+- spec/fleetly/logitem_spec.rb
+- spec/fleetly/user_spec.rb
+- spec/fleetly_spec.rb
+- spec/spec_helper.rb
+homepage: http://www.motivationscience.com
+licenses:
+- MIT
+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: -4260483002897082736
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4260483002897082736
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: API Wrapper for Fleetly
+test_files:
+- spec/fleetly/activity_spec.rb
+- spec/fleetly/client_spec.rb
+- spec/fleetly/logitem_spec.rb
+- spec/fleetly/user_spec.rb
+- spec/fleetly_spec.rb
+- spec/spec_helper.rb
+has_rdoc: