tmdby 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 52b4a16f72493c3a91c4c59b4f631b6317c4732d
-  data.tar.gz: 90ae3ecd556dccf5ed7562a64f53d83ad26b9b83
+  metadata.gz: 5eafca0483e87f20c1e1b9aa113341b0dd1af224
+  data.tar.gz: ac9d6ebacf0e57523d080619a8c6ad06467eec38
 SHA512:
-  metadata.gz: e29b083591ffef57db46c09768be50d5a55f0394e019f6242ce56d58b8bce0586c368bc539bf06e8e84ad7b868021114faf7d8b1da8344232ae946ddff9aad10
-  data.tar.gz: 12f29f943c0556884bae5ead3d87a1028675cc9c15bbbae15fbf5211d6e6438a767a21ce7c6451c883a29e52faad8f207debc7fe8968b022e5e22285594672ad
+  metadata.gz: 939029eab5f1ae9728739beee76008548d0aea3d845a621f71951654200d994bb30cac37fde7db5d6bf1e4e1bc73182b96ba52c90a7d34b0e54978609deb0f68
+  data.tar.gz: 99f2c4346c9a484796678f57f34717e51848e4f6c23c2cb233cdb2bb8b65b07cedde861e8f334a91bb71390c151c94e55d94788b7cd930082d57bcc877a52651

data/README.md

@@ -1,8 +1,16 @@
-# Tmdby
+**work in progress**
 
-TODO: Write a gem description
+TMDBY : a Ruby wrapper for the [TMDB API](http://docs.themoviedb.apiary.io/)
+---------------
 
-## Installation
+Features
+--------
+
+- Full integration of all the TMDB API
+
+
+Installation
+------------
 
 Add this line to your application's Gemfile:
 
@@ -18,13 +26,94 @@ Or install it yourself as:
 
     $ gem install tmdby
 
-## Usage
+How to use
+----------
+
+Every API is encapsulated in its own ruby class. For example, the Movie API is in lib/wrappers/movie.rb
+
+**Configuration**
+
+Set up your api key :
+
+```ruby
+Tmdby::Setup.key = "your_api_key"
+```
+
+By default, every call to TMDB Api is set in insecure mode (HTTP).
+If you want to enable HTTPS :
+
+```ruby
+Tmdby::Setup.secure = true
+```
+
+If you want, you can set a default language value :
+
+```ruby
+Tmdby::Setup.default_language = "fr"
+```
+
+**Example of use**
+
+- Get Movie by id :
+
+ ```ruby
+ Tmdby::Movies.get 550
+ ```
+- Find by IMDB id :
+
+ ```ruby
+ Tmdby::Find.get "tt0266543", 'imdb_id', language:'es'
+ ```
+
+- Discover Movies by criterias :
+
+ ```ruby
+ Tmdby::Discover.movie year: 1994, with_cast: 1269
+ ```
+
+You can take a look in the _tests_ directory to view a lot of examples.
+
+
+Helpers
+-------
+
+_todo_
+
+Running tests
+-------------
+
+First you have to enter your credentials (_API\_KEY_, _ACCOUNT\_ID_, _USERNAME_ and _PASSWORD_) in _tests/credentials.rb_
+
+Then you can run the test suite :
+
+```
+% ruby tests/minitest_all.rb
+
+Run options: --seed 60805
+
+# Running:
+
+.......................................................S...................................................................S.
+
+Finished in 53.308930s, 2.3448 runs/s, 16.0573 assertions/s.
+
+125 runs, 856 assertions, 0 failures, 0 errors, 2 skips
+
+You have skipped tests. Run with --verbose for details.
+```
+
+More to come
+------------
+
+- callback parameter support
+- images helpers
+
 
-TODO: Write usage instructions here
 
-## Contributing
+Contributing
+------------
 
-1. Fork it ( https://github.com/[my-github-username]/tmdby/fork )
+1. Fork it ( https://github.com/a-legrand/tmdby/fork )
 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`)

data/lib/tmdby/version.rb

@@ -1,3 +1,3 @@
 module Tmdby
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tmdby
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Aurélien Le Grand
@@ -68,7 +68,6 @@ files:
 - lib/tmdby/client.rb
 - lib/tmdby/helpers/authentication.rb
 - lib/tmdby/response.rb
-- lib/tmdby/setup.rb
 - lib/tmdby/version.rb
 - lib/tmdby/wrapper.rb
 - lib/tmdby/wrappers/account.rb