sodacan 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1e2878a19c2e3c2e2c5c2a3a53fd3757626af587
+  data.tar.gz: 4335d7c5a9656b9c88a30737f8b607a62cd7f1dc
+SHA512:
+  metadata.gz: 6f430404f72766743419210026778ef914e02df4724b04dfec16dff25cdafff4a31d9b05d8834be493635af435503745af6f6040236a919a2b77db16fa30c005
+  data.tar.gz: 64ea068ce0a131ee770cf5279776f938a3b6d2e2582656830d63f293d6d101d6fa3f8da2577a3a590d19a81b731aeec897932a2667cceed3cedabfcfee669d09

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 2.0.0@opendata --create

data/Gemfile

@@ -0,0 +1,9 @@
+source 'http://rubygems.org'
+
+gem 'rest-client'
+gem 'json'
+
+group :development do
+  gem 'rspec', '2.13.0'
+  gem 'pry'
+end

data/Gemfile.lock

@@ -0,0 +1,32 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    coderay (1.0.9)
+    diff-lcs (1.2.2)
+    json (1.7.7)
+    method_source (0.8.1)
+    mime-types (1.22)
+    pry (0.9.12)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.1)
+    slop (3.4.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  json
+  pry
+  rest-client
+  rspec (= 2.13.0)

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Trevor John, tjohn
+
+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,60 @@
+#SodaCan
+
+An ActiveRecord-like interface to databases with a JSON based Soda2 interface, and example of which is the NYC OpenData set.
+
+##Usage
+
+A new database should be added to an application by subclassing SodaCan::Base
+
+    class MyDB < SodaCan::Base
+    end
+
+This new class comes with a host of query methods out of the box. Before querying the database, connect it to the Soda2 database
+
+    MyDB.connect [uri string here]
+
+##Query Methods
+
+All query methods are class methods on a DB class. Query methods return instances of the DB class, just like ActiveRecord.
+
+###.many
+
+Returns an array of up to the first 1000 instances in the database
+
+###.execute _query_
+
+Returns the instances retrieved as a result of sending the query to the database
+
+###.find _id_
+
+Returns the instance in the database with the given ID, nil if the id is not found
+
+###.search _term_
+
+Returns an array of any instances that have the term string as a value for any field. Search works only for full tokens in the database. "ban" will match "ban on apples" but not "bananas are good"
+
+###.where _params_
+
+Returns an array of instances where the field represented by the key in the params hash has the value represented by the value in the params hash
+
+##Instance methods
+
+###\#\_fields
+
+Returns a hash of field names and types found in the instance
+
+###\#accessors
+
+Depending upon the record being accessed a number of accessor methods are created for the instance, allowing access to the fields.
+
+##Example
+
+    class MyDB < SodaCan::Base
+    end
+
+    MyDB.connect 'http://someurl.com/'
+
+    first = MyDB.find 1
+    bananas = MyDB.search "banana"
+    bananas.first.calories # calorie count of the first banana
+    fruit = MyDB.where(food_group: 'fruit')

data/Rakefile

@@ -0,0 +1,6 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+# If you want to make this the default task
+task :default => :spec

data/SodaCan.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sodacan/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sodacan"
+  spec.version       = SodaCan::VERSION
+  spec.authors       = ["Trevor John, tjohn", "Tyler Heck, theck01"]
+  spec.email         = ["tyler.heck@gmail.com"]
+  spec.description   = %q{Wrapper to make ActiveRecord type queries on Soda2 interfaces.}
+  spec.summary       = %q{SOQL Wrapper for JSON Soda 2 interfaces}
+  spec.homepage      = "http://rubygems.org/gems/sodacan"
+  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_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+
+  spec.add_runtime_dependency "json", ["= 1.7.7"]
+  spec.add_runtime_dependency "rest-client", ["= 1.6.7"]
+end

data/lib/sodacan/base.rb

@@ -0,0 +1,102 @@
+module SodaCan
+  class Base
+
+    def initialize (data, fields)
+
+      used_fields = {}
+      data.each do |key,val|
+        method_name = key.to_sym
+
+        case fields[method_name]
+        when "number"
+          val = BigDecimal(val)
+        when "double"
+          val = Float(val)
+        when "boolean"
+          if val =~ /(true|1)/
+            val = true
+          else
+            val = false
+          end
+        when "location"
+          val = Location.new val
+        when "calendar_date"
+          val = Time.new val
+        end
+
+        used_fields[method_name] = fields[method_name]
+        define_singleton_method(method_name){ val }
+      end
+
+      define_singleton_method(:_fields){ used_fields }
+    end
+
+
+    class << self
+
+      @@url = nil
+
+      def many
+        send_query @@url
+      end
+
+      def connect (url)
+        @@url = url.to_s
+      end
+
+      def execute (soql)
+        query = "#{ @@url }?$query=#{ soql }"
+        send_query query
+      end
+
+      def find (id)
+        where(id: id).first
+      end
+
+      def search (term)
+        query = "#{ @@url }?$q=#{ term }"
+        send_query query
+      end
+
+      def where (params)
+        query = "#{ @@url }?"
+
+        if params.has_key?(:id)
+          query << "$limit=1&$offset=#{ params[:id].to_i-1 }"
+          params.delete(:id)
+        end
+
+        unless params.empty?
+          query << "$where="
+
+          query = params.to_a.reduce(query) do |q,pair|
+            if pair[1].is_a? Numeric
+              q << "#{ pair[0] }=#{ pair[1] }&"
+            else
+              q << "#{ pair[0] }=\"#{ pair[1] }\"&"
+            end
+          end
+          query = query[0..-2]
+        end
+
+        send_query query
+      end
+
+
+      protected
+
+      def send_query (query)
+        response = RestClient.get query
+
+        field_names = JSON.parse(response.headers[:x_soda2_fields])
+        field_types = JSON.parse(response.headers[:x_soda2_types])
+        fields = field_names.zip(field_types).reduce({}) do |memo, pair|
+          memo[pair[0].to_sym] = pair[1]
+          memo
+        end
+
+        JSON.parse(response.body).map{ |data_hash| self.new(data_hash,fields) }
+      end
+    end
+  end
+end

data/lib/sodacan/location.rb

@@ -0,0 +1,12 @@
+module SodaCan
+  class Location
+    def initialize (params)
+      lat = nil
+      lat = Float(params['latitude']) if params['latitude']
+      long = nil
+      long = Float(params['longtitude']) if params['longitude']
+      define_singleton_method(:latitude){ lat }
+      define_singleton_method(:longitude){ long }
+    end
+  end
+end

data/lib/sodacan/version.rb

@@ -0,0 +1,3 @@
+module SodaCan
+  VERSION = "0.0.4"
+end

data/lib/sodacan.rb

@@ -0,0 +1,10 @@
+require 'bigdecimal'
+require 'json'
+require 'rest-client'
+
+require 'sodacan/base'
+require 'sodacan/location'
+require 'sodacan/version'
+
+module SodaCan
+end

data/spec/sodacan_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe SodaCan::Base do
+  before do
+  end
+
+  describe ".connect" do
+    it "sets the url" do
+      @url = "some_url"
+      expect {
+        puts Market.connect( @url )
+      }.to change { Market.instance_variables }.to eq(@url)
+
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'soqlmapper' # and any other gems you need
+
+RSpec.configure do |config|
+  # some (optional) config here
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: sodacan
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- Trevor John, tjohn
+- Tyler Heck, theck01
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.7.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.7.7
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.6.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.6.7
+description: Wrapper to make ActiveRecord type queries on Soda2 interfaces.
+email:
+- tyler.heck@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .rspec
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- SodaCan.gemspec
+- lib/sodacan.rb
+- lib/sodacan/base.rb
+- lib/sodacan/location.rb
+- lib/sodacan/version.rb
+- spec/sodacan_spec.rb
+- spec/spec_helper.rb
+homepage: http://rubygems.org/gems/sodacan
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.2
+signing_key: 
+specification_version: 4
+summary: SOQL Wrapper for JSON Soda 2 interfaces
+test_files:
+- spec/sodacan_spec.rb
+- spec/spec_helper.rb