jsoneur 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a18331361578a5fbfd4614f06f21142313087ba1
+  data.tar.gz: 2d2497bae8d8cece0dd3c07242cebb2bc3629f6c
+SHA512:
+  metadata.gz: 7887ff54a7a7033fd0a997bc6240a6c7c5ba2e682c2c83e8951fced6d37ae76f4542f41588c291d66e7bcbecd5b04a019481170e82fa103b49cdda7267bc0d03
+  data.tar.gz: 5c4172f8a7a8a80212f2ea3b4a287f469e1860dc82412caee4cc8afd88b2b5be1beab3fabb81efbfb636f3038bec38a3aa07542b49c0736311fd39375935a865

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 @@
+--color
+--format progress

data/.ruby-gemset

@@ -0,0 +1 @@
+jsoneur

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.0.0-p247

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'awesome_print'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Georg Kunz, http://georgkunz.coms
+
+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,92 @@
+# Jsoneur
+
+A very simple, general purpose JSON API client to quickly consume (read) any sane JSON API. 
+It is based on Faraday, provides a service registry for configuring multiple 
+API endpoints and allows quick usage of these services.
+
+Features:
+
+* Path and query string parameters.
+* No intermediate classes need to be setup.
+* Simple endpoint setup and access on a configures service.
+* Flexible processing of requests and responses through Faraday.
+* Returns JSON as a Mash which means it can be accessed in a pseudo-object way and is nice for using it in  templates.
+
+
+Limitations:
+
+* Only get requests for now
+* No splitting between query string and path parameters
+* Probably many more ...
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'jsoneur'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jsoneur
+
+## Usage
+
+A simple example
+
+```ruby
+require 'jsoneur'
+
+# Configure Github API
+Jsoneur.add('github_user_repos', 'https://api.github.com') do |service|
+  service.path = '/users/%{user}/repos'
+  
+  # Define default parameters (default: {})
+  # service.default_params = {search: 'search-term'}
+  
+  # Define the empty reponse in case nothing is found (default: [])
+  # service.empty_response = {}
+
+  # Setup your own Faraday Middleware stack
+  # service.connection do |faraday|
+  #   faraday.response :mashify
+  #   faraday.response :xml,  :content_type => /\bxml$/
+  #   # or set the Jsoneur defaults by calling
+  #   set_faraday_defaults(faraday)
+  # edd
+end
+
+# Configure another API, e.g. Twitter
+Jsoneur.add('tweets', 'https://api.twitter.com') do |service|
+  service.path = '/1.1/statuses/user_timeline.json'
+  # ...
+end
+
+
+# Consume an API
+repos = Jsoneur['github_user_repos'].get(user: 'geku')
+repos.each do |r|
+  puts "#{r.name} (#{r.owner.login})"
+end
+
+```
+
+For a running example, see `examples/github.rb`.
+
+
+## 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
+
+
+## License
+
+MIT License. Copyright 2013 Georg Kunz, http://georgkunz.com

data/Rakefile

@@ -0,0 +1,5 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')
+task :default => :spec
+task :test => [:spec]

data/examples/github.rb

@@ -0,0 +1,29 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'jsoneur'
+
+#
+# Jsoneur example to list all public
+# Github repos of a certain user
+#
+
+if ARGV.size < 1
+  puts "\n!!! Wrong number of parameters\n\n"
+  puts "ruby github.rb <username>"
+  exit
+end
+
+Jsoneur.add('github_user_repos', 'https://api.github.com') do |service|
+  service.path = '/users/%{user}/repos'
+end
+
+repos = Jsoneur['github_user_repos'].get(user: ARGV.first)
+repos.each do |r|
+  puts "  Name:  #{r.name}"
+  puts "  Owner: #{r.owner.login}"
+  puts "  Desc:  #{r.description}"
+  puts "  Lang:  #{r.language}"
+  puts ""
+  puts "=============================================="
+  puts ""
+end

data/jsoneur.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jsoneur/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "jsoneur"
+  spec.version       = Jsoneur::VERSION
+  spec.authors       = ["Georg Kunz"]
+  spec.email         = ["kwd@gmx.ch"]
+  spec.description   = 'General purpose JSON API client'
+  spec.summary       = 'Very simple and generic JSON API client based on Faraday and providing a service registry for configuration and usage of multiple services.'
+  spec.homepage      = "http://georgkunz.com"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 1.9"
+
+  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_runtime_dependency 'hashie'
+  spec.add_runtime_dependency 'multi_json'
+  spec.add_runtime_dependency 'faraday'
+  spec.add_runtime_dependency 'faraday_middleware'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 2.14'
+end

data/lib/Jsoneur/version.rb

@@ -0,0 +1,3 @@
+module Jsoneur
+  VERSION = "0.1.0"
+end

data/lib/jsoneur.rb

@@ -0,0 +1,23 @@
+require 'faraday'
+require 'faraday_middleware'
+
+require 'jsoneur/version'
+require 'jsoneur/service'
+
+module Jsoneur
+  class << self
+
+    def services
+      @services ||= {}
+    end
+
+    def add(name, base_url, &block)
+      services[name] = Service.new(name, base_url, &block)
+    end
+
+    def [](service_name)
+      services[service_name]
+    end
+
+  end
+end

data/lib/jsoneur/service.rb

@@ -0,0 +1,64 @@
+require 'open-uri'
+
+module Jsoneur
+  class Service
+
+    # Config methods
+    attr_accessor :path, :default_params, :empty_response
+
+    def initialize(name, base_url, &block)
+      @name         = name
+      @base_url     = base_url
+
+      # Set default config
+      @default_params = {}
+      @empty_response = []
+
+      block.call(self)
+
+      if @faraday.nil?
+        @faraday  = Faraday.new(@base_url) do |f|
+          set_faraday_defaults(f)
+        end
+      end
+    end
+
+    def connection(&block)
+      @faraday  = Faraday.new(@base_url, &block)
+    end
+
+    def set_faraday_defaults(faraday)
+      faraday.request :json
+
+      faraday.response :mashify
+      faraday.response :json, :content_type => /\bjson$/
+      
+      faraday.adapter Faraday.default_adapter
+    end
+
+    # Raises (depending on adapter that is used, by default NetHTTP)
+    # * Faraday::Error::ConnectionFailed on connection problems
+    # * Faraday::Error::TimeoutError     on timeouts
+    # e.g. Typhoeus raises Faraday::Error::ClientError as well
+    def get(params = {})
+      final_path = path % urlencoded_params(params)
+      result = @faraday.get(final_path, default_params.merge(params))
+
+      if result && result.success? && result.body
+        result.body 
+      else
+        empty_response
+      end
+    end
+
+
+    private
+      def urlencoded_params(params)
+        safe_params = params.dup
+        safe_params.each do |key, value|
+          safe_params[key] = URI::encode(value)
+        end
+      end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'jsoneur'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: jsoneur
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Georg Kunz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+description: General purpose JSON API client
+email:
+- kwd@gmx.ch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-gemset
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/github.rb
+- jsoneur.gemspec
+- lib/Jsoneur/version.rb
+- lib/jsoneur.rb
+- lib/jsoneur/service.rb
+- spec/spec_helper.rb
+homepage: http://georgkunz.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Very simple and generic JSON API client based on Faraday and providing a
+  service registry for configuration and usage of multiple services.
+test_files:
+- spec/spec_helper.rb