spot2fish 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8f8c48cb14c5f4be38fdfc474c14b1aee964e0ce
+  data.tar.gz: fc2b7df9ecbaac7607cb3eb321ffa4eb64bbc297
+SHA512:
+  metadata.gz: 3c8c0bc70b3e30ae443332ded173e279575d8e5dc7a38680b165cdb370240f262e15a4d5bba5f3c9a8fcd936d03525fe2326963ce16b5b5f8e8938073177755f
+  data.tar.gz: ad05b7c75083585aa8907376b4a04c0f577b36468745d41cee6f208429551ebc74c506a1835aaf5062013a289697913edd329e85561c570d9955f8cf063461bb

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

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.1

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Scott Mascio
+
+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,100 @@
+![alt tag](https://pbs.twimg.com/profile_images/492814839643787264/lewtdkhX_200x200.png) 
+
+# Spot2fish Gem
+
+
+A Ruby library for the Spot2fish API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'spot2fish'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install spot2fish
+
+## Usage
+
+##### Retrieve the first 15 fishing spots.
+
+`Spot2fish.all`
+
+*Pass a page number as an arguement, to paginate.*
+
+`Spot2fish.all(2)`
+
+##### Search
+
+`Spot2fish.search('Columbus, Ohio')`
+
+`Spot2fish.search('Ohio')`
+
+##### Search Social Media
+
+`Spot2fish.search_social_media('Columbus, Ohio')`
+
+`Spot2fish.search_social_media('Ohio')`
+
+##### *Search* versus *Search Social Media*
+
+`Spot2fish.search('Ohio')` will search the Spot2fish API for any spots near the location passed.
+
+`Spot2fish.search_social_media('Columbus, Ohio')` will search the Twitter API as well as the Instagram API for any fishing realated posts within a 60 mile radious of the location passed.
+
+> The `search` method may be perferable due to the rate limiting restrictions on both the Twitter API as well as the Instagram API.
+
+
+##### Response
+
+**Metadata**
+
+    "metadata": {
+        "api_for": "Spot2fish.com",
+        "total_spots": 4500,
+        "spots_on_current_page": 15,
+        "current_page": 2,
+        "total_pages": 300,
+        "next_page": 3,
+        "next_page_link": "?page=3",
+        "previous_page": 1,
+        "previous_page_link": "?page=1"
+    }
+
+**Array of Spot objects**
+
+    "spots": [
+        {
+         "id": 9000,
+         "social_media": "twitter",
+         "name": "_s_mas",
+         "social_media_id": "1234567890.0",
+         "image": "https://pbs.twimg.com/media/CLuki9uUkAE-jGV.png",
+         "text": "\"Let's go fishing"\",
+         "lat": "48.8489689",
+         "long": "2.3057026",
+         "location": "Columbus, Ohio",
+         "date": null,
+         "rank": 1,
+         "created_at": null,
+         "updated_at": null,
+         "avatar": "https://pbs.twimg.com/profile_images/492814839643787264/lewtdkhX_normal.png",
+         "extlocation": null,
+         "social_media_id_str": "674175896752947200",
+         "nfr": false
+        }
+     ]
+
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/spot2fish.rb

@@ -0,0 +1,19 @@
+require_relative "spot2fish/version"
+require_relative "spot2fish/response"
+
+module Spot2fish
+  def self.all(page = 1)
+
+    Spot2fishResponse.new('/spots', nil, page).api_response
+  end
+
+  def self.search(city, page = 1)
+
+    Spot2fishResponse.new('/spots/saved_spots', city, page).api_response
+  end
+
+  def self.search_social_media(city, page = 1)
+
+    Spot2fishResponse.new('/spots/search', city, page).api_response
+  end
+end

data/lib/spot2fish/response.rb

@@ -0,0 +1,37 @@
+require "httparty"
+
+class Spot2fishResponse
+  include HTTParty
+  base_uri "api.spot2fish.com/api/v1"
+
+  def initialize(path, city, page = 1)
+    @path = path
+    @city = city
+    @page = page
+    @params = params
+  end
+
+  def api_response
+    response = httparty_connection
+
+    if valid_response?(response.code)
+      response.parsed_response
+    else
+      "ERROR: Status #{response.code}"
+    end
+  end
+
+  private
+
+  def valid_response?(code)
+    code == 200
+  end
+
+  def params
+    { query: { city: @city, page: @page} }
+  end
+
+  def httparty_connection
+    self.class.get(@path, @params)
+  end
+end

data/lib/spot2fish/version.rb

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

data/spec/response_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe Spot2fishResponse do
+
+  it 'should have the base URI set to the proper spot2fish api endpoint' do
+
+    expect(Spot2fishResponse.base_uri).to eq "http://api.spot2fish.com/api/v1"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'spot2fish'

data/spec/spot2fish_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe Spot2fish do
+  it 'should have a version number' do
+
+    Spot2fish::VERSION.should_not be_nil
+  end
+end

data/spot2fish.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'spot2fish/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "spot2fish"
+  spec.version       = Spot2fish::VERSION
+  spec.authors       = ["Scott Mascio"]
+  spec.email         = ["scottmascio@gmail.com"]
+  spec.summary       = %q{Ruby library for the Spot2fish API.}
+  spec.description   = %q{Search the Spot2fish API for fishing spots.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rspec"
+
+  spec.add_dependency "httparty", "~> 0.13.7"
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: spot2fish
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Scott Mascio
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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: pry
+  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: rspec
+  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: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.7
+description: Search the Spot2fish API for fishing spots.
+email:
+- scottmascio@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/spot2fish.rb
+- lib/spot2fish/response.rb
+- lib/spot2fish/version.rb
+- spec/response_spec.rb
+- spec/spec_helper.rb
+- spec/spot2fish_spec.rb
+- spot2fish.gemspec
+homepage: ''
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Ruby library for the Spot2fish API.
+test_files:
+- spec/response_spec.rb
+- spec/spec_helper.rb
+- spec/spot2fish_spec.rb