foursquare_document 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
+/nbproject/private/

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Niels V
+
+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,47 @@
+# FoursquareDocument
+
+Quick and easy foursquare venue_info cache in your mongo documents
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'foursquare_document'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install foursquare_document
+
+## Usage
+
+include FoursquareDocument in your document and assign a field to contain the foursquare_id.
+This will automatically embed a foursquare_cache document in your model. It is set using a after_save callback.
+
+```ruby
+class Venue
+  include Mongoid::Document
+  include FoursquareDocument
+
+  foursquare_id :fs_id
+end
+```
+
+Create an initializer to set the foursquare credentials
+```ruby
+FoursquareDocument::Config.configure do |c|
+ c.client_id = <your-id>
+ c.client_secret = <your-secret>
+end
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/foursquare_document.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/foursquare_document/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Niels V"]
+  gem.email         = ["nvdk@arguslabs.be"]
+  gem.description   = "Easily add foursquare venue information to any mongoid document."
+  gem.summary       = "Embed foursquare venue information to any mongoid document."
+  gem.homepage      = ""
+
+  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.name          = "foursquare_document"
+  gem.require_paths = ["lib"]
+  gem.version       = FoursquareDocument::VERSION
+  gem.add_runtime_dependency "mongoid",  "~> 3.0.0"
+  gem.add_runtime_dependency 'foursquare2'
+end

data/lib/foursquare_document.rb

@@ -0,0 +1,49 @@
+require "foursquare_document/version"
+require "foursquare_document/models/foursquare_cache"
+require "foursquare_document/config"
+module FoursquareDocument
+  module ClassMethods
+    def foursquare_id(symbol,index=false)
+      field symbol, :type => Moped::BSON::ObjectId
+
+
+      if index
+        index({symbol => 1})
+      end
+      
+      attr_accessible symbol, :foursquare_cache
+      accepts_nested_attributes_for :foursquare_cache
+
+      class_eval <<-RUBY, __FILE__, __LINE__+1
+        define_callbacks :add_foursquare_info
+
+        set_callback(:save,:after) do |doc|
+            if doc.#{symbol}_changed? &&
+            (doc.foursquare_cache.blank? || !doc.foursquare_cache.changed?)
+              doc.add_foursquare_info
+            end
+        end
+
+
+        def add_foursquare_info
+          run_callbacks :add_foursquare_info do
+            client = FoursquareDocument::Config::get_client
+            venue_info = client.venue(self.#{symbol})
+            self.foursquare_cache = FoursquareCache.new(venue_info)
+            self.foursquare_cache.save!         
+          end
+        end
+      RUBY
+    end
+  end
+
+
+  def self.included(base)
+    # no need for activesupport::concern
+    base.send :extend, ClassMethods
+
+    base.class_eval do
+      embeds_one :foursquare_cache, :as => :fs_doc
+    end
+  end
+end

data/lib/foursquare_document/config.rb

@@ -0,0 +1,15 @@
+require "foursquare2"
+module FoursquareDocument
+  module Config
+    Configuration = Struct.new(:client_id,:client_secret)
+    FS_CONFIG = Configuration.new
+
+    def self.configure(&block)
+      yield FS_CONFIG
+    end
+    
+    def self.get_client
+      @client = Foursquare2::Client.new(:client_id => FS_CONFIG.client_id, :client_secret => FS_CONFIG.client_secret)
+    end
+  end
+end

data/lib/foursquare_document/models/foursquare_cache.rb

@@ -0,0 +1,14 @@
+class FoursquareCache
+  include Mongoid::Document
+  include Mongoid::Timestamps::Updated
+  
+  field :name,        :type => String
+  field :description, :type => String
+  field :categories,  :type => Array
+  field :location,    :type => Hash
+  field :id,          :type => Moped::BSON::ObjectId
+  
+  attr_accessible :name,:description,:categories,:location,:id
+  
+  embedded_in :fs_doc,:polymorphic => true
+end

data/lib/foursquare_document/version.rb

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

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: foursquare_document
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+  prerelease: 
+platform: ruby
+authors:
+- Niels V
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: &2164558940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *2164558940
+- !ruby/object:Gem::Dependency
+  name: foursquare2
+  requirement: &2164558520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2164558520
+description: Easily add foursquare venue information to any mongoid document.
+email:
+- nvdk@arguslabs.be
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- foursquare_document.gemspec
+- lib/foursquare_document.rb
+- lib/foursquare_document/config.rb
+- lib/foursquare_document/models/foursquare_cache.rb
+- lib/foursquare_document/version.rb
+homepage: ''
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.12
+signing_key: 
+specification_version: 3
+summary: Embed foursquare venue information to any mongoid document.
+test_files: []